Struct aws_sdk_kinesis::client::Client

pub struct Client<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }

Client for Amazon Kinesis

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

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_kinesis::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
    let shared_config = aws_config::load_from_env().await;
    let config = aws_sdk_kinesis::config::Builder::from(&shared_config)
        .retry_config(RetryConfig::disabled())
        .build();
    let client = aws_sdk_kinesis::Client::from_conf(config);

Implementations

impl<C, M, R> Client<C, M, R>

pub fn with_config(client: Client<C, M, R>, conf: Config) -> Self

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl<C, M, R> Client<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub fn add_tags_to_stream(&self) -> AddTagsToStream<C, M, R>

Constructs a fluent builder for the AddTagsToStream operation.

See AddTagsToStream for more information about the operation and its arguments.

pub fn create_stream(&self) -> CreateStream<C, M, R>

Constructs a fluent builder for the CreateStream operation.

See CreateStream for more information about the operation and its arguments.

pub fn decrease_stream_retention_period(
    &self
) -> DecreaseStreamRetentionPeriod<C, M, R>

Constructs a fluent builder for the DecreaseStreamRetentionPeriod operation.

See DecreaseStreamRetentionPeriod for more information about the operation and its arguments.

pub fn delete_stream(&self) -> DeleteStream<C, M, R>

Constructs a fluent builder for the DeleteStream operation.

See DeleteStream for more information about the operation and its arguments.

pub fn deregister_stream_consumer(&self) -> DeregisterStreamConsumer<C, M, R>

Constructs a fluent builder for the DeregisterStreamConsumer operation.

See DeregisterStreamConsumer for more information about the operation and its arguments.

pub fn describe_limits(&self) -> DescribeLimits<C, M, R>

Constructs a fluent builder for the DescribeLimits operation.

See DescribeLimits for more information about the operation and its arguments.

pub fn describe_stream(&self) -> DescribeStream<C, M, R>

Constructs a fluent builder for the DescribeStream operation.

See DescribeStream for more information about the operation and its arguments.

pub fn describe_stream_consumer(&self) -> DescribeStreamConsumer<C, M, R>

Constructs a fluent builder for the DescribeStreamConsumer operation.

See DescribeStreamConsumer for more information about the operation and its arguments.

pub fn describe_stream_summary(&self) -> DescribeStreamSummary<C, M, R>

Constructs a fluent builder for the DescribeStreamSummary operation.

See DescribeStreamSummary for more information about the operation and its arguments.

pub fn disable_enhanced_monitoring(&self) -> DisableEnhancedMonitoring<C, M, R>

Constructs a fluent builder for the DisableEnhancedMonitoring operation.

See DisableEnhancedMonitoring for more information about the operation and its arguments.

pub fn enable_enhanced_monitoring(&self) -> EnableEnhancedMonitoring<C, M, R>

Constructs a fluent builder for the EnableEnhancedMonitoring operation.

See EnableEnhancedMonitoring for more information about the operation and its arguments.

pub fn get_records(&self) -> GetRecords<C, M, R>

Constructs a fluent builder for the GetRecords operation.

See GetRecords for more information about the operation and its arguments.

pub fn get_shard_iterator(&self) -> GetShardIterator<C, M, R>

Constructs a fluent builder for the GetShardIterator operation.

See GetShardIterator for more information about the operation and its arguments.

pub fn increase_stream_retention_period(
    &self
) -> IncreaseStreamRetentionPeriod<C, M, R>

Constructs a fluent builder for the IncreaseStreamRetentionPeriod operation.

See IncreaseStreamRetentionPeriod for more information about the operation and its arguments.

pub fn list_shards(&self) -> ListShards<C, M, R>

Constructs a fluent builder for the ListShards operation.

See ListShards for more information about the operation and its arguments.

pub fn list_stream_consumers(&self) -> ListStreamConsumers<C, M, R>

Constructs a fluent builder for the ListStreamConsumers operation.

See ListStreamConsumers for more information about the operation and its arguments.

pub fn list_streams(&self) -> ListStreams<C, M, R>

Constructs a fluent builder for the ListStreams operation.

See ListStreams for more information about the operation and its arguments.

pub fn list_tags_for_stream(&self) -> ListTagsForStream<C, M, R>

Constructs a fluent builder for the ListTagsForStream operation.

See ListTagsForStream for more information about the operation and its arguments.

pub fn merge_shards(&self) -> MergeShards<C, M, R>

Constructs a fluent builder for the MergeShards operation.

See MergeShards for more information about the operation and its arguments.

pub fn put_record(&self) -> PutRecord<C, M, R>

Constructs a fluent builder for the PutRecord operation.

See PutRecord for more information about the operation and its arguments.

pub fn put_records(&self) -> PutRecords<C, M, R>

Constructs a fluent builder for the PutRecords operation.

See PutRecords for more information about the operation and its arguments.

pub fn register_stream_consumer(&self) -> RegisterStreamConsumer<C, M, R>

Constructs a fluent builder for the RegisterStreamConsumer operation.

See RegisterStreamConsumer for more information about the operation and its arguments.

pub fn remove_tags_from_stream(&self) -> RemoveTagsFromStream<C, M, R>

Constructs a fluent builder for the RemoveTagsFromStream operation.

See RemoveTagsFromStream for more information about the operation and its arguments.

pub fn split_shard(&self) -> SplitShard<C, M, R>

Constructs a fluent builder for the SplitShard operation.

See SplitShard for more information about the operation and its arguments.

pub fn start_stream_encryption(&self) -> StartStreamEncryption<C, M, R>

Constructs a fluent builder for the StartStreamEncryption operation.

See StartStreamEncryption for more information about the operation and its arguments.

pub fn stop_stream_encryption(&self) -> StopStreamEncryption<C, M, R>

Constructs a fluent builder for the StopStreamEncryption operation.

See StopStreamEncryption for more information about the operation and its arguments.

pub fn update_shard_count(&self) -> UpdateShardCount<C, M, R>

Constructs a fluent builder for the UpdateShardCount operation.

See UpdateShardCount for more information about the operation and its arguments.

pub fn update_stream_mode(&self) -> UpdateStreamMode<C, M, R>

Constructs a fluent builder for the UpdateStreamMode operation.

See UpdateStreamMode for more information about the operation and its arguments.

impl<C> Client<C, DefaultMiddleware, Standard>

pub fn from_conf_conn(conf: Config, conn: C) -> Self

Creates a client with the given service config and connector override.

impl Client<DynConnector, DefaultMiddleware, Standard>

pub fn new(config: &Config) -> Self

Creates a new client from a shared config.

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Trait Implementations

impl<C, M, R> Clone for Client<C, M, R>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for Client<C, M, R>

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

Formats the value using the given formatter.

impl<C, M, R> From<Client<C, M, R>> for Client<C, M, R>

fn from(client: Client<C, M, R>) -> Self

Performs the conversion.