Struct aws_sdk_iotdataplane::Client

pub struct Client { /* private fields */ }

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

impl Client

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

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl Client

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>

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>

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>

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>

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>

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. The default QoS level is 0.

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

  • user_properties(impl Into<String>) / set_user_properties(Option<String>):

    A 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>):

    An 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>):

    A UTF-8 encoded string that describes the content of the publishing message.

  • response_topic(impl Into<String>) / set_response_topic(Option<String>):

    A 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>):

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

    A 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>

pub fn update_thing_shadow(&self) -> UpdateThingShadow

Constructs a fluent builder for the UpdateThingShadow 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.

  • payload(Blob) / set_payload(Option<Blob>):

    The 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>

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.

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

• This method will panic if the conf 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 conf is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a copy 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.

impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client

fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self

Converts to this type from the input type.