Struct aws_sdk_dynamodbstreams::client::fluent_builders::GetRecords

pub struct GetRecords { /* private fields */ }

Fluent builder constructing a request to GetRecords.

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.

Implementations

impl GetRecords

pub async fn send(self) -> Result<GetRecordsOutput, SdkError<GetRecordsError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn shard_iterator(self, input: impl Into<String>) -> Self

A shard iterator that was retrieved from a previous GetShardIterator operation. This iterator can be used to access the stream records in this shard.

pub fn set_shard_iterator(self, input: Option<String>) -> Self

A shard iterator that was retrieved from a previous GetShardIterator operation. This iterator can be used to access the stream records in this shard.

pub fn limit(self, input: i32) -> Self

The maximum number of records to return from the shard. The upper limit is 1000.

pub fn set_limit(self, input: Option<i32>) -> Self

The maximum number of records to return from the shard. The upper limit is 1000.

Trait Implementations

impl Clone for GetRecords

fn clone(&self) -> GetRecords

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetRecords

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.