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.

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_iotdataplane::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::retry::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_iotdataplane::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_iotdataplane::Client::from_conf(config);

Implementations

source

impl Client

source

pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self

Creates a client with the given service configuration.

source

pub fn conf(&self) -> &Config

Returns the client’s configuration.

source

impl Client

source

pub fn delete_thing_shadow(&self) -> DeleteThingShadow

Constructs a fluent builder for the DeleteThingShadow operation.

The fluent builder is configurable:
- thing_name(impl Into<String>) / set_thing_name(Option<String>):
 The name of the thing.
- shadow_name(impl Into<String>) / set_shadow_name(Option<String>):
 The name of the shadow.
On success, responds with DeleteThingShadowOutput with field(s):
- payload(Option<Blob>):
 The state information, in JSON format.
On failure, responds with SdkError<DeleteThingShadowError>

source

pub fn get_retained_message(&self) -> GetRetainedMessage

Constructs a fluent builder for the GetRetainedMessage operation.

The fluent builder is configurable:
- topic(impl Into<String>) / set_topic(Option<String>):
 The 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.
On failure, responds with SdkError<GetRetainedMessageError>

source

pub fn get_thing_shadow(&self) -> GetThingShadow

Constructs a fluent builder for the GetThingShadow operation.

The fluent builder is configurable:
- thing_name(impl Into<String>) / set_thing_name(Option<String>):
 The name of the thing.
- shadow_name(impl Into<String>) / set_shadow_name(Option<String>):
 The 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

pub fn list_named_shadows_for_thing(&self) -> ListNamedShadowsForThing

Constructs a fluent builder for the ListNamedShadowsForThing operation.

The fluent builder is configurable:
- thing_name(impl Into<String>) / set_thing_name(Option<String>):
 The name of the thing.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token to retrieve the next set of results.
- page_size(i32) / set_page_size(Option<i32>):
 The 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

pub fn list_retained_messages(&self) -> ListRetainedMessages

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>):
 To 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(i32):
 The 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

pub fn publish(&self) -> Publish

Constructs a fluent builder for the Publish operation.

The fluent builder is configurable:
- topic(impl Into<String>) / set_topic(Option<String>):
 The name of the MQTT topic.
- qos(i32) / set_qos(i32):
 The Quality of Service (QoS) level.
- retain(bool) / set_retain(bool):
 A 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>):
 The 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.
On success, responds with PublishOutput
On failure, responds with SdkError<PublishError>