File Coverage

blib/lib/Paws/DynamoDBStreams/GetShardIterator.pm

Criterion	Covered	Total	%
statement	6	6	100.0
branch			n/a
condition			n/a
subroutine	2	2	100.0
pod			n/a
total	8	8	100.0

line	stmt	sub	time	code
1
2				package Paws::DynamoDBStreams::GetShardIterator;
3	1	1	417	use Moose;
	1		3
	1		6
4				has SequenceNumber => (is => 'ro', isa => 'Str');
5				has ShardId => (is => 'ro', isa => 'Str', required => 1);
6				has ShardIteratorType => (is => 'ro', isa => 'Str', required => 1);
7				has StreamArn => (is => 'ro', isa => 'Str', required => 1);
8
9	1	1	6194	use MooseX::ClassAttribute;
	1		3
	1		9
10
11				class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetShardIterator');
12				class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DynamoDBStreams::GetShardIteratorOutput');
13				class_has _result_key => (isa => 'Str', is => 'ro');
14				1;
15
16				### main pod documentation begin ###
17
18				=head1 NAME
19
20				Paws::DynamoDBStreams::GetShardIterator - Arguments for method GetShardIterator on Paws::DynamoDBStreams
21
22				=head1 DESCRIPTION
23
24				This class represents the parameters used for calling the method GetShardIterator on the
25				Amazon DynamoDB Streams service. Use the attributes of this class
26				as arguments to method GetShardIterator.
27
28				You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetShardIterator.
29
30				As an example:
31
32				$service_obj->GetShardIterator(Att1 => $value1, Att2 => $value2, ...);
33
34				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.
35
36				=head1 ATTRIBUTES
37
38
39				=head2 SequenceNumber => Str
40
41				The sequence number of a stream record in the shard from which to start
42				reading.
43
44
45
46				=head2 B<REQUIRED> ShardId => Str
47
48				The identifier of the shard. The iterator will be returned for this
49				shard ID.
50
51
52
53				=head2 B<REQUIRED> ShardIteratorType => Str
54
55				Determines how the shard iterator is used to start reading stream
56				records from the shard:
57
58				=over
59
60				=item *
61
62				C<AT_SEQUENCE_NUMBER> - Start reading exactly from the position denoted
63				by a specific sequence number.
64
65				=item *
66
67				C<AFTER_SEQUENCE_NUMBER> - Start reading right after the position
68				denoted by a specific sequence number.
69
70				=item *
71
72				C<TRIM_HORIZON> - Start reading at the last (untrimmed) stream record,
73				which is the oldest record in the shard. In DynamoDB Streams, there is
74				a 24 hour limit on data retention. Stream records whose age exceeds
75				this limit are subject to removal (trimming) from the stream.
76
77				=item *
78
79				C<LATEST> - Start reading just after the most recent stream record in
80				the shard, so that you always read the most recent data in the shard.
81
82				=back
83
84
85				Valid values are: C<"TRIM_HORIZON">, C<"LATEST">, C<"AT_SEQUENCE_NUMBER">, C<"AFTER_SEQUENCE_NUMBER">
86
87				=head2 B<REQUIRED> StreamArn => Str
88
89				The Amazon Resource Name (ARN) for the stream.
90
91
92
93
94				=head1 SEE ALSO
95
96				This class forms part of L<Paws>, documenting arguments for method GetShardIterator in L<Paws::DynamoDBStreams>
97
98				=head1 BUGS and CONTRIBUTIONS
99
100				The source code is located here: https://github.com/pplu/aws-sdk-perl
101
102				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
103
104				=cut
105