Client in aws_sdk_kinesis::client - Rust (original) (raw)

pub struct Client { /* private fields */ }

Expand description

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.

§Constructing a `Client`

A Config is required to construct a client. For most use cases, the aws-configcrate should be used to automatically resolve this config usingaws_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_kinesis::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_kinesis::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 AddTagsToStream operation has a Client::add_tags_to_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.add_tags_to_stream()
    .stream_name("example")
    .send()
    .await;

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

§Waiters

This client provides wait_until methods behind the Waiters trait. To use them, simply import the trait, and then call one of the wait_until methods. This will return a waiter fluent builder that takes various parameters, which are documented on the builder type. Once parameters have been provided, the wait method can be called to initiate waiting.

For example, if there was a wait_until_thing method, it could look like:

ⓘ

let result = client.wait_until_thing()
    .thing_id("someId")
    .wait(Duration::from_secs(120))
    .await;

Client in aws_sdk_kinesis::client - Rust (original) (raw)

§Constructing a Client

§Using the Client

§Waiters

§Panics

§Panics

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Example

§Constructing a `Client`

§Using the `Client`