Struct Client

pub struct Client { /* private fields */ }

Client for Amazon DynamoDB Streams

Client for invoking operations on Amazon DynamoDB Streams. Each operation on Amazon DynamoDB Streams is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_dynamodbstreams::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_dynamodbstreams::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the DescribeStream operation has a Client::describe_stream, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.describe_stream()
    .stream_arn("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn describe_stream(&self) -> DescribeStreamFluentBuilder

Constructs a fluent builder for the DescribeStream operation.

• The fluent builder is configurable:
  • stream_arn(impl Into<String>) / set_stream_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) for the stream.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    The maximum number of shard objects to return. The upper limit is 100.

    
    
  • exclusive_start_shard_id(impl Into<String>) / set_exclusive_start_shard_id(Option<String>):
    required: false
    

    The shard ID of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedShardId in the previous operation.

    
    
• On success, responds with DescribeStreamOutput with field(s):
  • stream_description(Option<StreamDescription>):

    A complete description of the stream, including its creation date and time, the DynamoDB table associated with the stream, the shard IDs within the stream, and the beginning and ending sequence numbers of stream records within the shards.

• On failure, responds with SdkError<DescribeStreamError>

impl Client

pub fn get_records(&self) -> GetRecordsFluentBuilder

Constructs a fluent builder for the GetRecords operation.

• The fluent builder is configurable:
  • shard_iterator(impl Into<String>) / set_shard_iterator(Option<String>):
    required: true
    

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

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

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

    
    
• On success, responds with GetRecordsOutput with field(s):
  • records(Option<Vec::<Record>>):

    The stream records from the shard, which were retrieved using the shard iterator.

  • next_shard_iterator(Option<String>):

    The next position in the shard from which to start sequentially reading stream records. If set to null, the shard has been closed and the requested iterator will not return any more data.

• On failure, responds with SdkError<GetRecordsError>

impl Client

pub fn get_shard_iterator(&self) -> GetShardIteratorFluentBuilder

Constructs a fluent builder for the GetShardIterator operation.

• The fluent builder is configurable:
  • stream_arn(impl Into<String>) / set_stream_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) for the stream.

    
    
  • shard_id(impl Into<String>) / set_shard_id(Option<String>):
    required: true
    

    The identifier of the shard. The iterator will be returned for this shard ID.

    
    
  • shard_iterator_type(ShardIteratorType) / set_shard_iterator_type(Option<ShardIteratorType>):
    required: true
    

    Determines how the shard iterator is used to start reading stream records from the shard:

    • AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a specific sequence number.

    • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number.

    • TRIM_HORIZON - Start reading at the last (untrimmed) stream record, which is the oldest record in the 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.

    • LATEST - Start reading just after the most recent stream record in the shard, so that you always read the most recent data in the shard.

    
    
  • sequence_number(impl Into<String>) / set_sequence_number(Option<String>):
    required: false
    

    The sequence number of a stream record in the shard from which to start reading.

    
    
• On success, responds with GetShardIteratorOutput with field(s):
  • shard_iterator(Option<String>):

    The position in the shard from which to start reading stream records sequentially. A shard iterator specifies this position using the sequence number of a stream record in a shard.

• On failure, responds with SdkError<GetShardIteratorError>

impl Client

pub fn list_streams(&self) -> ListStreamsFluentBuilder

Constructs a fluent builder for the ListStreams operation.

• The fluent builder is configurable:
  • table_name(impl Into<String>) / set_table_name(Option<String>):
    required: false
    

    If this parameter is provided, then only the streams associated with this table name are returned.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    The maximum number of streams to return. The upper limit is 100.

    
    
  • exclusive_start_stream_arn(impl Into<String>) / set_exclusive_start_stream_arn(Option<String>):
    required: false
    

    The ARN (Amazon Resource Name) of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedStreamArn in the previous operation.

    
    
• On success, responds with ListStreamsOutput with field(s):
  • streams(Option<Vec::<Stream>>):

    A list of stream descriptors associated with the current account and endpoint.

  • last_evaluated_stream_arn(Option<String>):

    The stream ARN of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

    If LastEvaluatedStreamArn is empty, then the “last page” of results has been processed and there is no more data to be retrieved.

    If LastEvaluatedStreamArn is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedStreamArn is empty.

• On failure, responds with SdkError<ListStreamsError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.