Struct Client

pub struct Client { /* private fields */ }

Client for Amazon Keyspaces Streams

Client for invoking operations on Amazon Keyspaces Streams. Each operation on Amazon Keyspaces 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_keyspacesstreams::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_keyspacesstreams::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 GetRecords operation has a Client::get_records, 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.get_records()
    .shard_iterator("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 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
    

    The unique identifier of the shard iterator. A shard iterator specifies the position in the shard from which you want to start reading data records sequentially. You obtain this value by calling the GetShardIterator operation. Each shard iterator is valid for 15 minutes after creation.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of records to return in a single GetRecords request. Default value is 1000. You can specify a limit between 1 and 1000, but the actual number returned might be less than the specified maximum if the size of the data for the returned records exceeds the internal size limit.

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

    An array of change data records retrieved from the specified shard. Each record represents a single data modification (insert, update, or delete) to a row in the Amazon Keyspaces table. Records include the primary key columns and information about what data was modified.

  • next_shard_iterator(Option<String>):

    The next position in the shard from which to start sequentially reading data records. If null, the shard has been closed and the requested iterator doesn’t 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) of the stream for which to get the shard iterator. The ARN uniquely identifies the stream within Amazon Keyspaces.

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

    The identifier of the shard within the stream. The shard ID uniquely identifies a subset of the stream’s data records that you want to access.

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

    Determines how the shard iterator is positioned. Must be one of the following:

    • TRIM_HORIZON - Start reading at the last untrimmed record in the shard, which is the oldest data record in the shard.

    • AT_SEQUENCE_NUMBER - Start reading exactly from the specified sequence number.

    • AFTER_SEQUENCE_NUMBER - Start reading right after the specified sequence number.

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

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

    The sequence number of the data record in the shard from which to start reading. Required if ShardIteratorType is AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER. This parameter is ignored for other iterator types.

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

    The unique identifier for the shard iterator. This value is used in the GetRecords operation to retrieve data records from the specified shard. Each shard iterator expires 15 minutes after it is returned to the requester.

• On failure, responds with SdkError<GetShardIteratorError>

impl Client

pub fn get_stream(&self) -> GetStreamFluentBuilder

Constructs a fluent builder for the GetStream operation. This operation supports pagination; See into_paginator().

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

    The Amazon Resource Name (ARN) of the stream for which detailed information is requested. This uniquely identifies the specific stream you want to get information about.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of shard objects to return in a single GetStream request. Default value is 100. The minimum value is 1 and the maximum value is 100.

    
    
  • shard_filter(ShardFilter) / set_shard_filter(Option<ShardFilter>):
    required: false
    

    Optional filter criteria to apply when retrieving shards. You can filter shards based on their state or other attributes to narrow down the results returned by the GetStream operation.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    An optional pagination token provided by a previous GetStream operation. If this parameter is specified, the response includes only records beyond the token, up to the value specified by maxResults.

    
    
• On success, responds with GetStreamOutput with field(s):
  • stream_arn(String):

    The Amazon Resource Name (ARN) that uniquely identifies the stream within Amazon Keyspaces. This ARN can be used in other API operations to reference this specific stream.

  • stream_label(String):

    A timestamp that serves as a unique identifier for this stream, used for debugging and monitoring purposes. The stream label represents the point in time when the stream was created.

  • stream_status(StreamStatus):

    The current status of the stream. Values can be ENABLING, ENABLED, DISABLING, or DISABLED. Operations on the stream depend on its current status.

  • stream_view_type(StreamViewType):

    The format of the data records in this stream. Currently, this can be one of the following options:

    • NEW_AND_OLD_IMAGES - both versions of the row, before and after the change. This is the default.

    • NEW_IMAGE - the version of the row after the change.

    • OLD_IMAGE - the version of the row before the change.

    • KEYS_ONLY - the partition and clustering keys of the row that was changed.

  • creation_request_date_time(DateTime):

    The date and time when the request to create this stream was issued. The value is represented in ISO 8601 format.

  • keyspace_name(String):

    The name of the keyspace containing the table associated with this stream. The keyspace name is part of the table’s hierarchical identifier in Amazon Keyspaces.

  • table_name(String):

    The name of the table associated with this stream. The stream captures changes to rows in this Amazon Keyspaces table.

  • shards(Option<Vec::<Shard>>):

    An array of shard objects associated with this stream. Each shard contains a subset of the stream’s data records and has its own unique identifier. The collection of shards represents the complete stream data.

  • next_token(Option<String>):

    A pagination token that can be used in a subsequent GetStream request. This token is returned if the response contains more shards than can be returned in a single response.

• On failure, responds with SdkError<GetStreamError>

impl Client

pub fn list_streams(&self) -> ListStreamsFluentBuilder

Constructs a fluent builder for the ListStreams operation. This operation supports pagination; See into_paginator().

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

    The name of the keyspace for which to list streams. If specified, only streams associated with tables in this keyspace are returned. If omitted, streams from all keyspaces are included in the results.

    
    
  • table_name(impl Into<String>) / set_table_name(Option<String>):
    required: false
    

    The name of the table for which to list streams. Must be used together with keyspaceName. If specified, only streams associated with this specific table are returned.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of streams to return in a single ListStreams request. Default value is 100. The minimum value is 1 and the maximum value is 100.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    An optional pagination token provided by a previous ListStreams operation. If this parameter is specified, the response includes only records beyond the token, up to the value specified by maxResults.

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

    An array of stream objects, each containing summary information about a stream including its ARN, status, and associated table information. This list includes all streams that match the request criteria.

  • next_token(Option<String>):

    A pagination token that can be used in a subsequent ListStreams request. This token is returned if the response contains more streams than can be returned in a single response based on the MaxResults parameter.

• 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 duplicate 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.