aws-elixir v0.1.0 AWS.DynamoDB.Streams
Amazon DynamoDB
Amazon DynamoDB Streams provides API actions for accessing streams and processing stream records. To learn more about application development with Streams, see Capturing Table Activity with DynamoDB Streams in the Amazon DynamoDB Developer Guide.
The following are short descriptions of each low-level DynamoDB Streams action:
- *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.
Summary
Functions
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
Retrieves the stream records from a given shard
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
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
Functions
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.
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.
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.
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.