pub struct DynamoDbStreamsClient { /* private fields */ }
Expand description
A client for the Amazon DynamoDB Streams API.
Implementations§
Source§impl DynamoDbStreamsClient
impl DynamoDbStreamsClient
Sourcepub fn new(region: Region) -> DynamoDbStreamsClient
pub fn new(region: Region) -> DynamoDbStreamsClient
Creates a client backed by the default tokio event loop.
The client will use the default credentials provider and tls client.
pub fn new_with<P, D>(
request_dispatcher: D,
credentials_provider: P,
region: Region,
) -> DynamoDbStreamsClientwhere
P: ProvideAwsCredentials + Send + Sync + 'static,
D: DispatchSignedRequest + Send + Sync + 'static,
pub fn new_with_client(client: Client, region: Region) -> DynamoDbStreamsClient
Trait Implementations§
Source§impl Clone for DynamoDbStreamsClient
impl Clone for DynamoDbStreamsClient
Source§fn clone(&self) -> DynamoDbStreamsClient
fn clone(&self) -> DynamoDbStreamsClient
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl DynamoDbStreams for DynamoDbStreamsClient
impl DynamoDbStreams for DynamoDbStreamsClient
Source§fn describe_stream<'life0, 'async_trait>(
&'life0 self,
input: DescribeStreamInput,
) -> Pin<Box<dyn Future<Output = Result<DescribeStreamOutput, RusotoError<DescribeStreamError>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn describe_stream<'life0, 'async_trait>(
&'life0 self,
input: DescribeStreamInput,
) -> Pin<Box<dyn Future<Output = Result<DescribeStreamOutput, RusotoError<DescribeStreamError>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
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.
Source§fn get_records<'life0, 'async_trait>(
&'life0 self,
input: GetRecordsInput,
) -> Pin<Box<dyn Future<Output = Result<GetRecordsOutput, RusotoError<GetRecordsError>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn get_records<'life0, 'async_trait>(
&'life0 self,
input: GetRecordsInput,
) -> Pin<Box<dyn Future<Output = Result<GetRecordsOutput, RusotoError<GetRecordsError>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
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.
Source§fn get_shard_iterator<'life0, 'async_trait>(
&'life0 self,
input: GetShardIteratorInput,
) -> Pin<Box<dyn Future<Output = Result<GetShardIteratorOutput, RusotoError<GetShardIteratorError>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn get_shard_iterator<'life0, 'async_trait>(
&'life0 self,
input: GetShardIteratorInput,
) -> Pin<Box<dyn Future<Output = Result<GetShardIteratorOutput, RusotoError<GetShardIteratorError>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
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.
Source§fn list_streams<'life0, 'async_trait>(
&'life0 self,
input: ListStreamsInput,
) -> Pin<Box<dyn Future<Output = Result<ListStreamsOutput, RusotoError<ListStreamsError>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn list_streams<'life0, 'async_trait>(
&'life0 self,
input: ListStreamsInput,
) -> Pin<Box<dyn Future<Output = Result<ListStreamsOutput, RusotoError<ListStreamsError>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
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.