aws_dynamodb_streams
Summary
Functions
-
describe_stream(Client, Input)
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.
- describe_stream(Client, Input, Options)
-
get_records(Client, Input)
Retrieves the stream records from a given shard.
- get_records(Client, Input, Options)
-
get_shard_iterator(Client, Input)
Returns a shard iterator.
- get_shard_iterator(Client, Input, Options)
-
list_streams(Client, Input)
Returns an array of stream ARNs associated with the current account and endpoint.
- list_streams(Client, Input, Options)
Functions
describe_stream(Client, Input)
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.
DescribeStream
at a maximum rate of 10
times per second.
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, then that shard is
closed and can no longer receive more data.
describe_stream(Client, Input, Options)
get_records(Client, Input)
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
1000 stream records, whichever comes first.
get_records(Client, Input, Options)
get_shard_iterator(Client, Input)
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.
get_shard_iterator(Client, Input, Options)
list_streams(Client, Input)
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.
ListStreams
at a maximum rate of 5 times
per second.