AWS SDK Version 2 for .NET
API Reference

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.

.NET Framework 3.5
 
Implementation for accessing DynamoDBStreams 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:

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

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient

Namespace: Amazon.DynamoDBv2
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public class AmazonDynamoDBStreamsClient : AmazonServiceClient
         IAmazonDynamoDBStreams, IDisposable

The AmazonDynamoDBStreamsClient type exposes the following members

Constructors

NameDescription
Public Method AmazonDynamoDBStreamsClient() Constructs AmazonDynamoDBStreamsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             
Public Method AmazonDynamoDBStreamsClient(RegionEndpoint) Constructs AmazonDynamoDBStreamsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             
Public Method AmazonDynamoDBStreamsClient(AmazonDynamoDBStreamsConfig) Constructs AmazonDynamoDBStreamsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             
Public Method AmazonDynamoDBStreamsClient(AWSCredentials) Constructs AmazonDynamoDBStreamsClient with AWS Credentials
Public Method AmazonDynamoDBStreamsClient(AWSCredentials, RegionEndpoint) Constructs AmazonDynamoDBStreamsClient with AWS Credentials
Public Method AmazonDynamoDBStreamsClient(AWSCredentials, AmazonDynamoDBStreamsConfig) Constructs AmazonDynamoDBStreamsClient with AWS Credentials and an AmazonDynamoDBStreamsClient Configuration object.
Public Method AmazonDynamoDBStreamsClient(string, string) Constructs AmazonDynamoDBStreamsClient with AWS Access Key ID and AWS Secret Key
Public Method AmazonDynamoDBStreamsClient(string, string, RegionEndpoint) Constructs AmazonDynamoDBStreamsClient with AWS Access Key ID and AWS Secret Key
Public Method AmazonDynamoDBStreamsClient(string, string, AmazonDynamoDBStreamsConfig) Constructs AmazonDynamoDBStreamsClient with AWS Access Key ID, AWS Secret Key and an AmazonDynamoDBStreamsClient Configuration object.
Public Method AmazonDynamoDBStreamsClient(string, string, string) Constructs AmazonDynamoDBStreamsClient with AWS Access Key ID and AWS Secret Key
Public Method AmazonDynamoDBStreamsClient(string, string, string, RegionEndpoint) Constructs AmazonDynamoDBStreamsClient with AWS Access Key ID and AWS Secret Key
Public Method AmazonDynamoDBStreamsClient(string, string, string, AmazonDynamoDBStreamsConfig) Constructs AmazonDynamoDBStreamsClient with AWS Access Key ID, AWS Secret Key and an AmazonDynamoDBStreamsClient Configuration object.

Methods

NameDescription
Public Method BeginDescribeStream(DescribeStreamRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeStream operation.
Public Method BeginGetRecords(GetRecordsRequest, AsyncCallback, object) Initiates the asynchronous execution of the GetRecords operation.
Public Method BeginGetShardIterator(GetShardIteratorRequest, AsyncCallback, object) Initiates the asynchronous execution of the GetShardIterator operation.
Public Method BeginListStreams(ListStreamsRequest, AsyncCallback, object) Initiates the asynchronous execution of the ListStreams operation.
Public Method 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 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.

Public Method 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 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.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method EndDescribeStream(IAsyncResult) Finishes the asynchronous execution of the DescribeStream operation.
Public Method EndGetRecords(IAsyncResult) Finishes the asynchronous execution of the GetRecords operation.
Public Method EndGetShardIterator(IAsyncResult) Finishes the asynchronous execution of the GetShardIterator operation.
Public Method EndListStreams(IAsyncResult) Finishes the asynchronous execution of the ListStreams operation.
Public Method GetRecords(string) 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.

Public Method GetRecords(GetRecordsRequest) 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.

Public Method 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.

Public Method 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.

Public Method 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.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.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