Struct aws_sdk_iotdataplane::client::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for AWS IoT Data Plane
Client for invoking operations on AWS IoT Data Plane. Each operation on AWS IoT Data Plane 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_iotdataplane::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 Config
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_iotdataplane::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 DeleteThingShadow
operation has
a Client::delete_thing_shadow
, 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.delete_thing_shadow()
.thing_name("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§
source§impl Client
impl Client
sourcepub fn delete_thing_shadow(&self) -> DeleteThingShadowFluentBuilder
pub fn delete_thing_shadow(&self) -> DeleteThingShadowFluentBuilder
Constructs a fluent builder for the DeleteThingShadow
operation.
- The fluent builder is configurable:
thing_name(impl Into<String>)
/set_thing_name(Option<String>)
:
required: trueThe name of the thing.
shadow_name(impl Into<String>)
/set_shadow_name(Option<String>)
:
required: falseThe name of the shadow.
- On success, responds with
DeleteThingShadowOutput
with field(s):payload(Blob)
:The state information, in JSON format.
- On failure, responds with
SdkError<DeleteThingShadowError>
source§impl Client
impl Client
sourcepub fn get_retained_message(&self) -> GetRetainedMessageFluentBuilder
pub fn get_retained_message(&self) -> GetRetainedMessageFluentBuilder
Constructs a fluent builder for the GetRetainedMessage
operation.
- The fluent builder is configurable:
topic(impl Into<String>)
/set_topic(Option<String>)
:
required: trueThe topic name of the retained message to retrieve.
- On success, responds with
GetRetainedMessageOutput
with field(s):topic(Option<String>)
:The topic name to which the retained message was published.
payload(Option<Blob>)
:The Base64-encoded message payload of the retained message body.
qos(i32)
:The quality of service (QoS) level used to publish the retained message.
last_modified_time(i64)
:The Epoch date and time, in milliseconds, when the retained message was stored by IoT.
user_properties(Option<Blob>)
:A base64-encoded JSON string that includes an array of JSON objects, or null if the retained message doesn’t include any user properties.
The following example
userProperties
parameter is a JSON string that represents two user properties. Note that it will be base64-encoded:[{“deviceName”: “alpha”}, {“deviceCnt”: “45”}]
- On failure, responds with
SdkError<GetRetainedMessageError>
source§impl Client
impl Client
sourcepub fn get_thing_shadow(&self) -> GetThingShadowFluentBuilder
pub fn get_thing_shadow(&self) -> GetThingShadowFluentBuilder
Constructs a fluent builder for the GetThingShadow
operation.
- The fluent builder is configurable:
thing_name(impl Into<String>)
/set_thing_name(Option<String>)
:
required: trueThe name of the thing.
shadow_name(impl Into<String>)
/set_shadow_name(Option<String>)
:
required: falseThe name of the shadow.
- On success, responds with
GetThingShadowOutput
with field(s):payload(Option<Blob>)
:The state information, in JSON format.
- On failure, responds with
SdkError<GetThingShadowError>
source§impl Client
impl Client
sourcepub fn list_named_shadows_for_thing(
&self
) -> ListNamedShadowsForThingFluentBuilder
pub fn list_named_shadows_for_thing( &self ) -> ListNamedShadowsForThingFluentBuilder
Constructs a fluent builder for the ListNamedShadowsForThing
operation.
- The fluent builder is configurable:
thing_name(impl Into<String>)
/set_thing_name(Option<String>)
:
required: trueThe name of the thing.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token to retrieve the next set of results.
page_size(i32)
/set_page_size(Option<i32>)
:
required: falseThe result page size.
- On success, responds with
ListNamedShadowsForThingOutput
with field(s):results(Option<Vec::<String>>)
:The list of shadows for the specified thing.
next_token(Option<String>)
:The token to use to get the next set of results, or null if there are no additional results.
timestamp(i64)
:The Epoch date and time the response was generated by IoT.
- On failure, responds with
SdkError<ListNamedShadowsForThingError>
source§impl Client
impl Client
sourcepub fn list_retained_messages(&self) -> ListRetainedMessagesFluentBuilder
pub fn list_retained_messages(&self) -> ListRetainedMessagesFluentBuilder
Constructs a fluent builder for the ListRetainedMessages
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseTo retrieve the next set of results, the
nextToken
value from a previous response; otherwise null to receive the first set of results.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return at one time.
- On success, responds with
ListRetainedMessagesOutput
with field(s):retained_topics(Option<Vec::<RetainedMessageSummary>>)
:A summary list the account’s retained messages. The information returned doesn’t include the message payloads of the retained messages.
next_token(Option<String>)
:The token for the next set of results, or null if there are no additional results.
- On failure, responds with
SdkError<ListRetainedMessagesError>
source§impl Client
impl Client
sourcepub fn publish(&self) -> PublishFluentBuilder
pub fn publish(&self) -> PublishFluentBuilder
Constructs a fluent builder for the Publish
operation.
- The fluent builder is configurable:
topic(impl Into<String>)
/set_topic(Option<String>)
:
required: trueThe name of the MQTT topic.
qos(i32)
/set_qos(Option<i32>)
:
required: falseThe Quality of Service (QoS) level. The default QoS level is 0.
retain(bool)
/set_retain(Option<bool>)
:
required: falseA Boolean value that determines whether to set the RETAIN flag when the message is published.
Setting the RETAIN flag causes the message to be retained and sent to new subscribers to the topic.
Valid values:
true
|false
Default value:
false
payload(Blob)
/set_payload(Option<Blob>)
:
required: falseThe message body. MQTT accepts text, binary, and empty (null) message payloads.
Publishing an empty (null) payload with retain =
true
deletes the retained message identified by topic from Amazon Web Services IoT Core.user_properties(impl Into<String>)
/set_user_properties(Option<String>)
:
required: falseA JSON string that contains an array of JSON objects. If you don’t use Amazon Web Services SDK or CLI, you must encode the JSON string to base64 format before adding it to the HTTP header.
userProperties
is an HTTP header value in the API.The following example
userProperties
parameter is a JSON string which represents two User Properties. Note that it needs to be base64-encoded:[{“deviceName”: “alpha”}, {“deviceCnt”: “45”}]
payload_format_indicator(PayloadFormatIndicator)
/set_payload_format_indicator(Option<PayloadFormatIndicator>)
:
required: falseAn
Enum
string value that indicates whether the payload is formatted as UTF-8.payloadFormatIndicator
is an HTTP header value in the API.content_type(impl Into<String>)
/set_content_type(Option<String>)
:
required: falseA UTF-8 encoded string that describes the content of the publishing message.
response_topic(impl Into<String>)
/set_response_topic(Option<String>)
:
required: falseA UTF-8 encoded string that’s used as the topic name for a response message. The response topic is used to describe the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters.
correlation_data(impl Into<String>)
/set_correlation_data(Option<String>)
:
required: falseThe base64-encoded binary data used by the sender of the request message to identify which request the response message is for when it’s received.
correlationData
is an HTTP header value in the API.message_expiry(i64)
/set_message_expiry(Option<i64>)
:
required: falseA user-defined integer value that represents the message expiry interval in seconds. If absent, the message doesn’t expire. For more information about the limits of
messageExpiry
, see Amazon Web Services IoT Core message broker and protocol limits and quotas from the Amazon Web Services Reference Guide.
- On success, responds with
PublishOutput
- On failure, responds with
SdkError<PublishError>
source§impl Client
impl Client
sourcepub fn update_thing_shadow(&self) -> UpdateThingShadowFluentBuilder
pub fn update_thing_shadow(&self) -> UpdateThingShadowFluentBuilder
Constructs a fluent builder for the UpdateThingShadow
operation.
- The fluent builder is configurable:
thing_name(impl Into<String>)
/set_thing_name(Option<String>)
:
required: trueThe name of the thing.
shadow_name(impl Into<String>)
/set_shadow_name(Option<String>)
:
required: falseThe name of the shadow.
payload(Blob)
/set_payload(Option<Blob>)
:
required: trueThe state information, in JSON format.
- On success, responds with
UpdateThingShadowOutput
with field(s):payload(Option<Blob>)
:The state information, in JSON format.
- On failure, responds with
SdkError<UpdateThingShadowError>
source§impl Client
impl Client
sourcepub fn from_conf(conf: Config) -> Self
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
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
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 thesleep_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 thehttp_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, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more