C# Class Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient

Implementation for accessing DynamoDBStreams 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.

Inheritance: AmazonServiceClient, IAmazonDynamoDBStreams
Exibir arquivo Open project: aws/aws-sdk-net

Public Methods

Method Description
AmazonDynamoDBStreamsClient ( ) : System

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>

AmazonDynamoDBStreamsClient ( AWSCredentials credentials ) : System

Constructs AmazonDynamoDBStreamsClient with AWS Credentials
AmazonDynamoDBStreamsClient ( AWSCredentials credentials, AmazonDynamoDBStreamsConfig clientConfig ) : System

Constructs AmazonDynamoDBStreamsClient with AWS Credentials and an AmazonDynamoDBStreamsClient Configuration object.
AmazonDynamoDBStreamsClient ( AWSCredentials credentials, RegionEndpoint region ) : System

Constructs AmazonDynamoDBStreamsClient with AWS Credentials
AmazonDynamoDBStreamsClient ( AmazonDynamoDBStreamsConfig config ) : System

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>

AmazonDynamoDBStreamsClient ( RegionEndpoint region ) : System

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>

AmazonDynamoDBStreamsClient ( string awsAccessKeyId, string awsSecretAccessKey ) : System

Constructs AmazonDynamoDBStreamsClient with AWS Access Key ID and AWS Secret Key
AmazonDynamoDBStreamsClient ( string awsAccessKeyId, string awsSecretAccessKey, AmazonDynamoDBStreamsConfig clientConfig ) : System

Constructs AmazonDynamoDBStreamsClient with AWS Access Key ID, AWS Secret Key and an AmazonDynamoDBStreamsClient Configuration object.
AmazonDynamoDBStreamsClient ( string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region ) : System

Constructs AmazonDynamoDBStreamsClient with AWS Access Key ID and AWS Secret Key
AmazonDynamoDBStreamsClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken ) : System

Constructs AmazonDynamoDBStreamsClient with AWS Access Key ID and AWS Secret Key
AmazonDynamoDBStreamsClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonDynamoDBStreamsConfig clientConfig ) : System

Constructs AmazonDynamoDBStreamsClient with AWS Access Key ID, AWS Secret Key and an AmazonDynamoDBStreamsClient Configuration object.
AmazonDynamoDBStreamsClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region ) : System

Constructs AmazonDynamoDBStreamsClient with AWS Access Key ID and AWS Secret Key
BeginDescribeStream ( DescribeStreamRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DescribeStream operation.
BeginGetRecords ( GetRecordsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the GetRecords operation.
BeginGetShardIterator ( GetShardIteratorRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the GetShardIterator operation.
BeginListStreams ( ListStreamsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the ListStreams operation.
DescribeStream ( DescribeStreamRequest request ) : Amazon.DynamoDBv2.Model.DescribeStreamResponse

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, then that shard is closed and can no longer receive more data.

DescribeStream ( string streamArn ) : Amazon.DynamoDBv2.Model.DescribeStreamResponse

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, then that shard is closed and can no longer receive more data.

DescribeStreamAsync ( DescribeStreamRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DescribeStream operation.
DescribeStreamAsync ( string streamArn, System cancellationToken = default(CancellationToken) ) : Task

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, then that shard is closed and can no longer receive more data.

EndDescribeStream ( IAsyncResult asyncResult ) : Amazon.DynamoDBv2.Model.DescribeStreamResponse

Finishes the asynchronous execution of the DescribeStream operation.
EndGetRecords ( IAsyncResult asyncResult ) : Amazon.DynamoDBv2.Model.GetRecordsResponse

Finishes the asynchronous execution of the GetRecords operation.
EndGetShardIterator ( IAsyncResult asyncResult ) : Amazon.DynamoDBv2.Model.GetShardIteratorResponse

Finishes the asynchronous execution of the GetShardIterator operation.
EndListStreams ( IAsyncResult asyncResult ) : Amazon.DynamoDBv2.Model.ListStreamsResponse

Finishes the asynchronous execution of the ListStreams operation.
GetRecords ( GetRecordsRequest request ) : Amazon.DynamoDBv2.Model.GetRecordsResponse

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.

GetRecords ( string shardIterator ) : Amazon.DynamoDBv2.Model.GetRecordsResponse

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.

GetRecordsAsync ( GetRecordsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the GetRecords operation.
GetRecordsAsync ( string shardIterator, System cancellationToken = default(CancellationToken) ) : Task

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.

GetShardIterator ( GetShardIteratorRequest request ) : Amazon.DynamoDBv2.Model.GetShardIteratorResponse

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.

GetShardIteratorAsync ( GetShardIteratorRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the GetShardIterator operation.
ListStreams ( ) : Amazon.DynamoDBv2.Model.ListStreamsResponse

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 request ) : Amazon.DynamoDBv2.Model.ListStreamsResponse

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.

ListStreamsAsync ( ListStreamsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the ListStreams operation.
ListStreamsAsync ( System cancellationToken = default(CancellationToken) ) : Task

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.

Protected Methods

Method Description
CreateSigner ( ) : AbstractAWSSigner

Creates the signer for the service.
CustomizeRuntimePipeline ( RuntimePipeline pipeline ) : void

Customize the pipeline
Dispose ( bool disposing ) : void

Disposes the service client.

Method Details

AmazonDynamoDBStreamsClient() public method

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 AmazonDynamoDBStreamsClient ( ) : System
return System

AmazonDynamoDBStreamsClient() public method

Constructs AmazonDynamoDBStreamsClient with AWS Credentials
public AmazonDynamoDBStreamsClient ( AWSCredentials credentials ) : System
credentials Amazon.Runtime.AWSCredentials AWS Credentials
return System

AmazonDynamoDBStreamsClient() public method

Constructs AmazonDynamoDBStreamsClient with AWS Credentials and an AmazonDynamoDBStreamsClient Configuration object.
public AmazonDynamoDBStreamsClient ( AWSCredentials credentials, AmazonDynamoDBStreamsConfig clientConfig ) : System
credentials Amazon.Runtime.AWSCredentials AWS Credentials
clientConfig AmazonDynamoDBStreamsConfig The AmazonDynamoDBStreamsClient Configuration Object
return System

AmazonDynamoDBStreamsClient() public method

Constructs AmazonDynamoDBStreamsClient with AWS Credentials
public AmazonDynamoDBStreamsClient ( AWSCredentials credentials, RegionEndpoint region ) : System
credentials Amazon.Runtime.AWSCredentials AWS Credentials
region RegionEndpoint The region to connect.
return System

AmazonDynamoDBStreamsClient() public method

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 AmazonDynamoDBStreamsClient ( AmazonDynamoDBStreamsConfig config ) : System
config AmazonDynamoDBStreamsConfig The AmazonDynamoDBStreamsClient Configuration Object
return System

AmazonDynamoDBStreamsClient() public method

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 AmazonDynamoDBStreamsClient ( RegionEndpoint region ) : System
region RegionEndpoint The region to connect.
return System

AmazonDynamoDBStreamsClient() public method

Constructs AmazonDynamoDBStreamsClient with AWS Access Key ID and AWS Secret Key
public AmazonDynamoDBStreamsClient ( string awsAccessKeyId, string awsSecretAccessKey ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
return System

AmazonDynamoDBStreamsClient() public method

Constructs AmazonDynamoDBStreamsClient with AWS Access Key ID, AWS Secret Key and an AmazonDynamoDBStreamsClient Configuration object.
public AmazonDynamoDBStreamsClient ( string awsAccessKeyId, string awsSecretAccessKey, AmazonDynamoDBStreamsConfig clientConfig ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
clientConfig AmazonDynamoDBStreamsConfig The AmazonDynamoDBStreamsClient Configuration Object
return System

AmazonDynamoDBStreamsClient() public method

Constructs AmazonDynamoDBStreamsClient with AWS Access Key ID and AWS Secret Key
public AmazonDynamoDBStreamsClient ( string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
region RegionEndpoint The region to connect.
return System

AmazonDynamoDBStreamsClient() public method

Constructs AmazonDynamoDBStreamsClient with AWS Access Key ID and AWS Secret Key
public AmazonDynamoDBStreamsClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
awsSessionToken string AWS Session Token
return System

AmazonDynamoDBStreamsClient() public method

Constructs AmazonDynamoDBStreamsClient with AWS Access Key ID, AWS Secret Key and an AmazonDynamoDBStreamsClient Configuration object.
public AmazonDynamoDBStreamsClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonDynamoDBStreamsConfig clientConfig ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
awsSessionToken string AWS Session Token
clientConfig AmazonDynamoDBStreamsConfig The AmazonDynamoDBStreamsClient Configuration Object
return System

AmazonDynamoDBStreamsClient() public method

Constructs AmazonDynamoDBStreamsClient with AWS Access Key ID and AWS Secret Key
public AmazonDynamoDBStreamsClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
awsSessionToken string AWS Session Token
region RegionEndpoint The region to connect.
return System

BeginDescribeStream() public method

Initiates the asynchronous execution of the DescribeStream operation.
public BeginDescribeStream ( DescribeStreamRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.DynamoDBv2.Model.DescribeStreamRequest Container for the necessary parameters to execute the DescribeStream operation on AmazonDynamoDBStreamsClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginGetRecords() public method

Initiates the asynchronous execution of the GetRecords operation.
public BeginGetRecords ( GetRecordsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.DynamoDBv2.Model.GetRecordsRequest Container for the necessary parameters to execute the GetRecords operation on AmazonDynamoDBStreamsClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginGetShardIterator() public method

Initiates the asynchronous execution of the GetShardIterator operation.
public BeginGetShardIterator ( GetShardIteratorRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.DynamoDBv2.Model.GetShardIteratorRequest Container for the necessary parameters to execute the GetShardIterator operation on AmazonDynamoDBStreamsClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginListStreams() public method

Initiates the asynchronous execution of the ListStreams operation.
public BeginListStreams ( ListStreamsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.DynamoDBv2.Model.ListStreamsRequest Container for the necessary parameters to execute the ListStreams operation on AmazonDynamoDBStreamsClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

CreateSigner() protected method

Creates the signer for the service.
protected CreateSigner ( ) : AbstractAWSSigner
return Amazon.Runtime.Internal.Auth.AbstractAWSSigner

CustomizeRuntimePipeline() protected method

Customize the pipeline
protected CustomizeRuntimePipeline ( RuntimePipeline pipeline ) : void
pipeline RuntimePipeline
return void

DescribeStream() public method

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, then that shard is closed and can no longer receive more data.

/// An error occurred on the server side. /// /// The operation tried to access a nonexistent stream. ///
public DescribeStream ( DescribeStreamRequest request ) : Amazon.DynamoDBv2.Model.DescribeStreamResponse
request Amazon.DynamoDBv2.Model.DescribeStreamRequest Container for the necessary parameters to execute the DescribeStream service method.
return Amazon.DynamoDBv2.Model.DescribeStreamResponse

DescribeStream() public method

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, then that shard is closed and can no longer receive more data.

/// An error occurred on the server side. /// /// The operation tried to access a nonexistent stream. ///
public DescribeStream ( string streamArn ) : Amazon.DynamoDBv2.Model.DescribeStreamResponse
streamArn string The Amazon Resource Name (ARN) for the stream.
return Amazon.DynamoDBv2.Model.DescribeStreamResponse

DescribeStreamAsync() public method

Initiates the asynchronous execution of the DescribeStream operation.
public DescribeStreamAsync ( DescribeStreamRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.DynamoDBv2.Model.DescribeStreamRequest Container for the necessary parameters to execute the DescribeStream operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeStreamAsync() public method

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, then that shard is closed and can no longer receive more data.

/// An error occurred on the server side. /// /// The operation tried to access a nonexistent stream. ///
public DescribeStreamAsync ( string streamArn, System cancellationToken = default(CancellationToken) ) : Task
streamArn string The Amazon Resource Name (ARN) for the stream.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

Dispose() protected method

Disposes the service client.
protected Dispose ( bool disposing ) : void
disposing bool
return void

EndDescribeStream() public method

Finishes the asynchronous execution of the DescribeStream operation.
public EndDescribeStream ( IAsyncResult asyncResult ) : Amazon.DynamoDBv2.Model.DescribeStreamResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDescribeStream.
return Amazon.DynamoDBv2.Model.DescribeStreamResponse

EndGetRecords() public method

Finishes the asynchronous execution of the GetRecords operation.
public EndGetRecords ( IAsyncResult asyncResult ) : Amazon.DynamoDBv2.Model.GetRecordsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginGetRecords.
return Amazon.DynamoDBv2.Model.GetRecordsResponse

EndGetShardIterator() public method

Finishes the asynchronous execution of the GetShardIterator operation.
public EndGetShardIterator ( IAsyncResult asyncResult ) : Amazon.DynamoDBv2.Model.GetShardIteratorResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginGetShardIterator.
return Amazon.DynamoDBv2.Model.GetShardIteratorResponse

EndListStreams() public method

Finishes the asynchronous execution of the ListStreams operation.
public EndListStreams ( IAsyncResult asyncResult ) : Amazon.DynamoDBv2.Model.ListStreamsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginListStreams.
return Amazon.DynamoDBv2.Model.ListStreamsResponse

GetRecords() public method

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.

/// The shard iterator has expired and can no longer be used to retrieve stream records. /// A shard iterator expires 15 minutes after it is retrieved using the GetShardIterator /// action. /// /// An error occurred on the server side. /// /// Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests /// that receive this exception. Your request is eventually successful, unless your retry /// queue is too large to finish. Reduce the frequency of requests and use exponential /// backoff. For more information, go to Error /// Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide. /// /// The operation tried to access a nonexistent stream. /// /// The operation attempted to read past the oldest stream record in a shard. /// /// /// /// In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose /// age exceeds this limit are subject to removal (trimming) from the stream. You might /// receive a TrimmedDataAccessException if: /// ///
  • /// /// You request a shard iterator with a sequence number older than the trim point (24 /// hours). /// ///
  • /// /// You obtain a shard iterator, but before you use the iterator in a GetRecords /// request, a stream record in the shard exceeds the 24 hour period and is trimmed. This /// causes the iterator to access a record that no longer exists. /// ///
///
public GetRecords ( GetRecordsRequest request ) : Amazon.DynamoDBv2.Model.GetRecordsResponse
request Amazon.DynamoDBv2.Model.GetRecordsRequest Container for the necessary parameters to execute the GetRecords service method.
return Amazon.DynamoDBv2.Model.GetRecordsResponse

GetRecords() public method

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.

/// The shard iterator has expired and can no longer be used to retrieve stream records. /// A shard iterator expires 15 minutes after it is retrieved using the GetShardIterator /// action. /// /// An error occurred on the server side. /// /// Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests /// that receive this exception. Your request is eventually successful, unless your retry /// queue is too large to finish. Reduce the frequency of requests and use exponential /// backoff. For more information, go to Error /// Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide. /// /// The operation tried to access a nonexistent stream. /// /// The operation attempted to read past the oldest stream record in a shard. /// /// /// /// In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose /// age exceeds this limit are subject to removal (trimming) from the stream. You might /// receive a TrimmedDataAccessException if: /// ///
  • /// /// You request a shard iterator with a sequence number older than the trim point (24 /// hours). /// ///
  • /// /// You obtain a shard iterator, but before you use the iterator in a GetRecords /// request, a stream record in the shard exceeds the 24 hour period and is trimmed. This /// causes the iterator to access a record that no longer exists. /// ///
///
public GetRecords ( string shardIterator ) : Amazon.DynamoDBv2.Model.GetRecordsResponse
shardIterator string A shard iterator that was retrieved from a previous GetShardIterator operation. This iterator can be used to access the stream records in this shard.
return Amazon.DynamoDBv2.Model.GetRecordsResponse

GetRecordsAsync() public method

Initiates the asynchronous execution of the GetRecords operation.
public GetRecordsAsync ( GetRecordsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.DynamoDBv2.Model.GetRecordsRequest Container for the necessary parameters to execute the GetRecords operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

GetRecordsAsync() public method

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.

/// The shard iterator has expired and can no longer be used to retrieve stream records. /// A shard iterator expires 15 minutes after it is retrieved using the GetShardIterator /// action. /// /// An error occurred on the server side. /// /// Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests /// that receive this exception. Your request is eventually successful, unless your retry /// queue is too large to finish. Reduce the frequency of requests and use exponential /// backoff. For more information, go to Error /// Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide. /// /// The operation tried to access a nonexistent stream. /// /// The operation attempted to read past the oldest stream record in a shard. /// /// /// /// In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose /// age exceeds this limit are subject to removal (trimming) from the stream. You might /// receive a TrimmedDataAccessException if: /// ///
  • /// /// You request a shard iterator with a sequence number older than the trim point (24 /// hours). /// ///
  • /// /// You obtain a shard iterator, but before you use the iterator in a GetRecords /// request, a stream record in the shard exceeds the 24 hour period and is trimmed. This /// causes the iterator to access a record that no longer exists. /// ///
///
public GetRecordsAsync ( string shardIterator, System cancellationToken = default(CancellationToken) ) : Task
shardIterator string A shard iterator that was retrieved from a previous GetShardIterator operation. This iterator can be used to access the stream records in this shard.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

GetShardIterator() public method

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.

/// An error occurred on the server side. /// /// The operation tried to access a nonexistent stream. /// /// The operation attempted to read past the oldest stream record in a shard. /// /// /// /// In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose /// age exceeds this limit are subject to removal (trimming) from the stream. You might /// receive a TrimmedDataAccessException if: /// ///
  • /// /// You request a shard iterator with a sequence number older than the trim point (24 /// hours). /// ///
  • /// /// You obtain a shard iterator, but before you use the iterator in a GetRecords /// request, a stream record in the shard exceeds the 24 hour period and is trimmed. This /// causes the iterator to access a record that no longer exists. /// ///
///
public GetShardIterator ( GetShardIteratorRequest request ) : Amazon.DynamoDBv2.Model.GetShardIteratorResponse
request Amazon.DynamoDBv2.Model.GetShardIteratorRequest Container for the necessary parameters to execute the GetShardIterator service method.
return Amazon.DynamoDBv2.Model.GetShardIteratorResponse

GetShardIteratorAsync() public method

Initiates the asynchronous execution of the GetShardIterator operation.
public GetShardIteratorAsync ( GetShardIteratorRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.DynamoDBv2.Model.GetShardIteratorRequest Container for the necessary parameters to execute the GetShardIterator operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

ListStreams() public method

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.

/// An error occurred on the server side. /// /// The operation tried to access a nonexistent stream. ///
public ListStreams ( ) : Amazon.DynamoDBv2.Model.ListStreamsResponse
return Amazon.DynamoDBv2.Model.ListStreamsResponse

ListStreams() public method

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.

/// An error occurred on the server side. /// /// The operation tried to access a nonexistent stream. ///
public ListStreams ( ListStreamsRequest request ) : Amazon.DynamoDBv2.Model.ListStreamsResponse
request Amazon.DynamoDBv2.Model.ListStreamsRequest Container for the necessary parameters to execute the ListStreams service method.
return Amazon.DynamoDBv2.Model.ListStreamsResponse

ListStreamsAsync() public method

Initiates the asynchronous execution of the ListStreams operation.
public ListStreamsAsync ( ListStreamsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.DynamoDBv2.Model.ListStreamsRequest Container for the necessary parameters to execute the ListStreams operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

ListStreamsAsync() public method

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.

/// An error occurred on the server side. /// /// The operation tried to access a nonexistent stream. ///
public ListStreamsAsync ( System cancellationToken = default(CancellationToken) ) : Task
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task