AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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:
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.
Namespace: Amazon.DynamoDBv2
Assembly: AWSSDK.dll
Version: (assembly version)
public interface IAmazonDynamoDBStreams IDisposable
The IAmazonDynamoDBStreams type exposes the following members
Name | Description | |
---|---|---|
BeginDescribeStream(DescribeStreamRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeStream operation. | |
BeginGetRecords(GetRecordsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the GetRecords operation. | |
BeginGetShardIterator(GetShardIteratorRequest, AsyncCallback, object) | Initiates the asynchronous execution of the GetShardIterator operation. | |
BeginListStreams(ListStreamsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the ListStreams operation. | |
DescribeStream(string) |
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 |
|
DescribeStream(DescribeStreamRequest) |
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 |
|
EndDescribeStream(IAsyncResult) | Finishes the asynchronous execution of the DescribeStream operation. | |
EndGetRecords(IAsyncResult) | Finishes the asynchronous execution of the GetRecords operation. | |
EndGetShardIterator(IAsyncResult) | Finishes the asynchronous execution of the GetShardIterator operation. | |
EndListStreams(IAsyncResult) | Finishes the asynchronous execution of the ListStreams operation. | |
GetRecords(string) |
Retrieves the stream records from a given shard.
Specify a shard iterator using the GetRecords can retrieve a maximum of 1 MB of data or 2000 stream records, whichever comes first. |
|
GetRecords(GetRecordsRequest) |
Retrieves the stream records from a given shard.
Specify a shard iterator using the GetRecords can retrieve a maximum of 1 MB of data or 2000 stream records, whichever comes first. |
|
GetShardIterator(GetShardIteratorRequest) |
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() |
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. |
|
ListStreams(ListStreamsRequest) |
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. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8
.NET for Windows Phone:
Supported in: Windows Phone 8