Expand description
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.
If you’re using the service, you’re probably looking for DynamoDbStreamsClient and DynamoDbStreams.
Structs§
- Attribute
Value Represents the data for an attribute. You can set one, and only one, of the elements.
Each attribute in an item is a name-value pair. An attribute can be single-valued or multi-valued set. For example, a book item can have title and authors attributes. Each book has one title but can have many authors. The multi-valued attribute is a set; duplicate values are not allowed.
- Describe
Stream Input Represents the input of a
DescribeStreamoperation.- Describe
Stream Output Represents the output of a
DescribeStreamoperation.- Dynamo
DbStreams Client - A client for the Amazon DynamoDB Streams API.
- GetRecords
Input Represents the input of a
GetRecordsoperation.- GetRecords
Output Represents the output of a
GetRecordsoperation.- GetShard
Iterator Input Represents the input of a
GetShardIteratoroperation.- GetShard
Iterator Output Represents the output of a
GetShardIteratoroperation.- Identity
Contains details about the type of identity that made the request.
- KeySchema
Element Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
A
KeySchemaElementrepresents exactly one attribute of the primary key. For example, a simple primary key (partition key) would be represented by oneKeySchemaElement. A composite primary key (partition key and sort key) would require oneKeySchemaElementfor the partition key, and anotherKeySchemaElementfor the sort key.The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
- List
Streams Input Represents the input of a
ListStreamsoperation.- List
Streams Output Represents the output of a
ListStreamsoperation.- Record
A description of a unique event within a stream.
- Sequence
Number Range The beginning and ending sequence numbers for the stream records contained within a shard.
- Shard
A uniquely identified group of stream records within a stream.
- Stream
Represents all of the data describing a particular stream.
- Stream
Description Represents all of the data describing a particular stream.
- Stream
Record A description of a single data modification that was performed on an item in a DynamoDB table.
Enums§
- Describe
Stream Error - Errors returned by DescribeStream
- GetRecords
Error - Errors returned by GetRecords
- GetShard
Iterator Error - Errors returned by GetShardIterator
- List
Streams Error - Errors returned by ListStreams
Traits§
- Dynamo
DbStreams - Trait representing the capabilities of the Amazon DynamoDB Streams API. Amazon DynamoDB Streams clients implement this trait.