File Coverage

blib/lib/Paws/DynamoDBStreams.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::DynamoDBStreams;
2 1     1   3681 use Moose;
  1         2  
  1         10  
3             sub service { 'streams.dynamodb' }
4             sub version { '2012-08-10' }
5             sub target_prefix { 'DynamoDBStreams_20120810' }
6             sub json_version { "1.0" }
7             has max_attempts => (is => 'ro', isa => 'Int', default => 5);
8             has retry => (is => 'ro', isa => 'HashRef', default => sub {
9             { base => 'rand', type => 'exponential', growth_factor => 2 }
10             });
11             has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [
12             ] });
13              
14             with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::JsonCaller', 'Paws::Net::JsonResponse';
15              
16            
17             sub DescribeStream {
18             my $self = shift;
19             my $call_object = $self->new_with_coercions('Paws::DynamoDBStreams::DescribeStream', @_);
20             return $self->caller->do_call($self, $call_object);
21             }
22             sub GetRecords {
23             my $self = shift;
24             my $call_object = $self->new_with_coercions('Paws::DynamoDBStreams::GetRecords', @_);
25             return $self->caller->do_call($self, $call_object);
26             }
27             sub GetShardIterator {
28             my $self = shift;
29             my $call_object = $self->new_with_coercions('Paws::DynamoDBStreams::GetShardIterator', @_);
30             return $self->caller->do_call($self, $call_object);
31             }
32             sub ListStreams {
33             my $self = shift;
34             my $call_object = $self->new_with_coercions('Paws::DynamoDBStreams::ListStreams', @_);
35             return $self->caller->do_call($self, $call_object);
36             }
37            
38              
39              
40             sub operations { qw/DescribeStream GetRecords GetShardIterator ListStreams / }
41              
42             1;
43              
44             ### main pod documentation begin ###
45              
46             =head1 NAME
47              
48             Paws::DynamoDBStreams - Perl Interface to AWS Amazon DynamoDB Streams
49              
50             =head1 SYNOPSIS
51              
52             use Paws;
53              
54             my $obj = Paws->service('DynamoDBStreams');
55             my $res = $obj->Method(
56             Arg1 => $val1,
57             Arg2 => [ 'V1', 'V2' ],
58             # if Arg3 is an object, the HashRef will be used as arguments to the constructor
59             # of the arguments type
60             Arg3 => { Att1 => 'Val1' },
61             # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
62             # the constructor of the arguments type
63             Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
64             );
65              
66             =head1 DESCRIPTION
67              
68             Amazon DynamoDB
69              
70             Amazon DynamoDB Streams provides API actions for accessing streams and
71             processing stream records. To learn more about application development
72             with Streams, see Capturing Table Activity with DynamoDB Streams in the
73             Amazon DynamoDB Developer Guide.
74              
75             =head1 METHODS
76              
77             =head2 DescribeStream(StreamArn => Str, [ExclusiveStartShardId => Str, Limit => Int])
78              
79             Each argument is described in detail in: L<Paws::DynamoDBStreams::DescribeStream>
80              
81             Returns: a L<Paws::DynamoDBStreams::DescribeStreamOutput> instance
82              
83             Returns information about a stream, including the current status of the
84             stream, its Amazon Resource Name (ARN), the composition of its shards,
85             and its corresponding DynamoDB table.
86              
87             You can call C<DescribeStream> at a maximum rate of 10 times per
88             second.
89              
90             Each shard in the stream has a C<SequenceNumberRange> associated with
91             it. If the C<SequenceNumberRange> has a C<StartingSequenceNumber> but
92             no C<EndingSequenceNumber>, then the shard is still open (able to
93             receive more stream records). If both C<StartingSequenceNumber> and
94             C<EndingSequenceNumber> are present, then that shard is closed and can
95             no longer receive more data.
96              
97              
98             =head2 GetRecords(ShardIterator => Str, [Limit => Int])
99              
100             Each argument is described in detail in: L<Paws::DynamoDBStreams::GetRecords>
101              
102             Returns: a L<Paws::DynamoDBStreams::GetRecordsOutput> instance
103              
104             Retrieves the stream records from a given shard.
105              
106             Specify a shard iterator using the C<ShardIterator> parameter. The
107             shard iterator specifies the position in the shard from which you want
108             to start reading stream records sequentially. If there are no stream
109             records available in the portion of the shard that the iterator points
110             to, C<GetRecords> returns an empty list. Note that it might take
111             multiple calls to get to a portion of the shard that contains stream
112             records.
113              
114             C<GetRecords> can retrieve a maximum of 1 MB of data or 1000 stream
115             records, whichever comes first.
116              
117              
118             =head2 GetShardIterator(ShardId => Str, ShardIteratorType => Str, StreamArn => Str, [SequenceNumber => Str])
119              
120             Each argument is described in detail in: L<Paws::DynamoDBStreams::GetShardIterator>
121              
122             Returns: a L<Paws::DynamoDBStreams::GetShardIteratorOutput> instance
123              
124             Returns a shard iterator. A shard iterator provides information about
125             how to retrieve the stream records from within a shard. Use the shard
126             iterator in a subsequent C<GetRecords> request to read the stream
127             records from the shard.
128              
129             A shard iterator expires 15 minutes after it is returned to the
130             requester.
131              
132              
133             =head2 ListStreams([ExclusiveStartStreamArn => Str, Limit => Int, TableName => Str])
134              
135             Each argument is described in detail in: L<Paws::DynamoDBStreams::ListStreams>
136              
137             Returns: a L<Paws::DynamoDBStreams::ListStreamsOutput> instance
138              
139             Returns an array of stream ARNs associated with the current account and
140             endpoint. If the C<TableName> parameter is present, then C<ListStreams>
141             will return only the streams ARNs for that table.
142              
143             You can call C<ListStreams> at a maximum rate of 5 times per second.
144              
145              
146              
147              
148             =head1 PAGINATORS
149              
150             Paginator methods are helpers that repetively call methods that return partial results
151              
152              
153              
154              
155             =head1 SEE ALSO
156              
157             This service class forms part of L<Paws>
158              
159             =head1 BUGS and CONTRIBUTIONS
160              
161             The source code is located here: https://github.com/pplu/aws-sdk-perl
162              
163             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
164              
165             =cut
166