NAME

Paws::DynamoDBStreams - Perl Interface to AWS Amazon DynamoDB Streams

SYNOPSIS

  use Paws;

  my $obj = Paws->service('DynamoDBStreams')->new;
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

Amazon DynamoDB Streams

This is the Amazon DynamoDB Streams API Reference. This guide describes the low-level API actions for accessing streams and processing stream records. For information about application development with DynamoDB Streams, see the Amazon DynamoDB Developer Guide.

Note that this document is intended for use with the following DynamoDB documentation:

Amazon DynamoDB Developer Guide
Amazon DynamoDB API Reference

The following are short descriptions of each low-level DynamoDB Streams API action, organized by function.

DescribeStream - Returns detailed information about a particular stream.
GetRecords - Retrieves the stream records from within a shard.
GetShardIterator - Returns information on how to retrieve the streams record from a shard with a given shard ID.
ListStreams - Returns a list of all the streams associated with the current AWS account and endpoint.

METHODS

DescribeStream(StreamArn => Str, [ExclusiveStartShardId => Str, Limit => Int])

Each argument is described in detail in: Paws::DynamoDBStreams::DescribeStream

Returns: a Paws::DynamoDBStreams::DescribeStreamOutput instance

Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table.

You can call DescribeStream at a maximum rate of 10 times per second.

Each shard in the stream has a "SequenceNumberRange" associated with it. If the "SequenceNumberRange" has a "StartingSequenceNumber" but no "EndingSequenceNumber", then the shard is still open (able to receive more stream records). If both "StartingSequenceNumber" and "EndingSequenceNumber" are present, the that shared is closed and can no longer receive more data.

GetRecords(ShardIterator => Str, [Limit => Int])

Each argument is described in detail in: Paws::DynamoDBStreams::GetRecords

Returns: a Paws::DynamoDBStreams::GetRecordsOutput instance

Retrieves the stream records from a given shard.

Specify a shard iterator using the "ShardIterator" parameter. The shard iterator specifies the position in the shard from which you want to start reading stream records sequentially. If there are no stream records available in the portion of the shard that the iterator points to, "GetRecords" returns an empty list. Note that it might take multiple calls to get to a portion of the shard that contains stream records.

GetRecords can retrieve a maximum of 1 MB of data or 2000 stream records, whichever comes first.

GetShardIterator(ShardId => Str, ShardIteratorType => Str, StreamArn => Str, [SequenceNumber => Str])

Each argument is described in detail in: Paws::DynamoDBStreams::GetShardIterator

Returns: a Paws::DynamoDBStreams::GetShardIteratorOutput instance

Returns a shard iterator. A shard iterator provides information about how to retrieve the stream records from within a shard. Use the shard iterator in a subsequent "GetRecords" request to read the stream records from the shard.

A shard iterator expires 15 minutes after it is returned to the requester.

ListStreams([ExclusiveStartStreamArn => Str, Limit => Int, TableName => Str])

Each argument is described in detail in: Paws::DynamoDBStreams::ListStreams

Returns: a Paws::DynamoDBStreams::ListStreamsOutput instance

Returns an array of stream ARNs associated with the current account and endpoint. If the "TableName" parameter is present, then ListStreams will return only the streams ARNs for that table.

You can call ListStreams at a maximum rate of 5 times per second.

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues