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