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

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 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_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 DeleteConnection operation has a Client::delete_connection, 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_connection()
    .client_id("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

impl Client

pub fn delete_connection(&self) -> DeleteConnectionFluentBuilder

Constructs a fluent builder for the DeleteConnection operation.

• The fluent builder is configurable:
  • client_id(impl Into<String>) / set_client_id(Option<String>):
    required: true
    

    The unique identifier of the MQTT client to disconnect. The client ID can’t start with a dollar sign ($).

    MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters.

    
    
  • clean_session(bool) / set_clean_session(Option<bool>):
    required: false
    

    Specifies whether to remove the client’s persistent session state when disconnecting. Set to TRUE to delete all session information, including subscriptions and queued messages. Set to FALSE to preserve the session state for persistent sessions. For clean sessions this parameter will be ignored. By default, this is set to FALSE (preserves the session state).

    
    
  • prevent_will_message(bool) / set_prevent_will_message(Option<bool>):
    required: false
    

    Controls if Amazon Web Services IoT Core publishes the client’s Last Will and Testament (LWT) message upon disconnection. Set to TRUE to prevent publishing the LWT message. Set to FALSE to ensure that LWT is published. By default, this is set to FALSE (LWT message is published).

    
    
• On success, responds with DeleteConnectionOutput
• On failure, responds with SdkError<DeleteConnectionError>

impl Client

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: true
    

    The name of the thing.

    
    
  • shadow_name(impl Into<String>) / set_shadow_name(Option<String>):
    required: false
    

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

impl Client

pub fn get_connection(&self) -> GetConnectionFluentBuilder

Constructs a fluent builder for the GetConnection operation.

• The fluent builder is configurable:
  • client_id(impl Into<String>) / set_client_id(Option<String>):
    required: true
    

    The unique identifier of the MQTT client to retrieve connection information. The client ID can’t start with a dollar sign ($).

    MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters.

    
    
  • include_socket_information(bool) / set_include_socket_information(Option<bool>):
    required: false
    

    Specifies if socket information (sourcePort, targetPort, sourceIp, targetIp) should be included in the GetConnection response. Set to TRUE to include socket information. Set to FALSE to omit socket information. By default, this is set to FALSE. See the developer guide for how to authorize this parameter.

    
    
• On success, responds with GetConnectionOutput with field(s):
  • connected(bool):

    The connection state of the client. Returns true if the client is currently connected, or false if the client is not connected.

  • thing_name(Option<String>):

    The name of the thing associated with the principal of the MQTT client, if applicable.

  • clean_session(bool):

    Indicates whether the client is using a clean session. Returns true for clean sessions or false for persistent sessions.

  • source_ip(Option<String>):

    The IP address of the client that initiated the connection.

  • source_port(i32):

    The client’s source port.

  • target_ip(Option<String>):

    The IP address of the Amazon Web Services IoT Core endpoint that the client connected to. For clients connected to VPC endpoints, this is the private IP address of the network interface the client is connected to.

  • target_port(i32):

    The port number of the Amazon Web Services IoT Core endpoint that the client connected to.

  • keep_alive_duration(i32):

    The keep-alive interval in seconds that the client specified when establishing the connection.

  • connected_since(i64):

    Unix timestamp (in milliseconds) indicating when the client connected. Present only when connected is true.

  • disconnected_since(i64):

    Unix timestamp (in milliseconds) indicating when the client disconnected. Present only when connected is false. This information is available for 30 minutes after the client disconnects.

  • disconnect_reason(Option<String>):

    The reason for the last disconnection, if the client is currently disconnected. See the developer guide for valid disconnect reasons.

  • session_expiry(i64):

    The session expiry interval in seconds for the MQTT client connection. This is configured by the user. This value indicates how long the session will remain active after the client disconnects.

  • client_id(Option<String>):

    The unique identifier of the MQTT client. This is the same client ID that was used when the client established the connection.

  • vpc_endpoint_id(Option<String>):

    The ID of the VPC endpoint. Present for clients connected to IoT Core via a VPC endpoint.

• On failure, responds with SdkError<GetConnectionError>

impl Client

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: true
    

    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.

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

impl Client

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: true
    

    The name of the thing.

    
    
  • shadow_name(impl Into<String>) / set_shadow_name(Option<String>):
    required: false
    

    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>

impl Client

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: true
    

    The name of the thing.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to retrieve the next set of results.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    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>

impl Client

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: false
    

    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(Option<i32>):
    required: false
    

    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>

impl Client

pub fn list_subscriptions(&self) -> ListSubscriptionsFluentBuilder

Constructs a fluent builder for the ListSubscriptions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • client_id(impl Into<String>) / set_client_id(Option<String>):
    required: true
    

    The unique identifier of the MQTT client to list subscriptions for. The client ID can’t start with a dollar sign ($).

    MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(Option<i32>):
    required: false
    

    The maximum number of subscriptions to return in a single request. By default, this is set to 20.

    
    
• On success, responds with ListSubscriptionsOutput with field(s):
  • subscriptions(Option<Vec::<SubscriptionSummary>>):

    A list of topic filters and their associated Quality of Service (QoS) levels that the client is subscribed to.

  • next_token(Option<String>):

    The token to use to get the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListSubscriptionsError>

impl Client

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: true
    

    The name of the MQTT topic.

    
    
  • qos(i32) / set_qos(Option<i32>):
    required: false
    

    The Quality of Service (QoS) level. The default QoS level is 0.

    
    
  • retain(bool) / set_retain(Option<bool>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: false
    

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

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

    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>):
    required: false
    

    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(Option<i64>):
    required: false
    

    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>

impl Client

pub fn send_direct_message(&self) -> SendDirectMessageFluentBuilder

Constructs a fluent builder for the SendDirectMessage operation.

• The fluent builder is configurable:
  • client_id(impl Into<String>) / set_client_id(Option<String>):
    required: true
    

    The unique identifier of the MQTT client to send the message to.

    Client IDs must not exceed 128 characters and can’t start with a dollar sign ($). MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters. For more information, see Amazon Web Services IoT Core message broker and protocol limits and quotas.

    
    
  • topic(impl Into<String>) / set_topic(Option<String>):
    required: true
    

    The topic of the outbound MQTT Publish message to the receiving client. For more information, see Amazon Web Services IoT Core message broker and protocol limits and quotas.

    
    
  • content_type(impl Into<String>) / set_content_type(Option<String>):
    required: false
    

    The MQTT5 content type property forwarded to the receiving client (for example, application/json).

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

    A UTF-8 encoded string that’s used as the topic name for a response message. The response topic describes the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters. For more information, see Amazon Web Services IoT Core message broker and protocol limits and quotas.

    
    
  • confirmation(bool) / set_confirmation(Option<bool>):
    required: false
    

    A Boolean value that specifies whether to wait for delivery confirmation from the receiving client.

    When set to true, the API delivers the message at QoS 1 and waits for the client to send a delivery confirmation (PUBACK) before returning a successful response. If delivery confirmation is not received within the specified timeout period, the API returns HTTP 504.

    When set to false, the API delivers the message at QoS 0 and returns after Amazon Web Services IoT Core attempts to deliver the message.

    Valid values: true | false

    Default value: false

    
    
  • timeout(i32) / set_timeout(Option<i32>):
    required: false
    

    An integer that represents the maximum time, in seconds, to wait for a delivery confirmation (PUBACK) from the receiving client after the message has been delivered. This parameter is only used when confirmation is set to true. If confirmation is false, this parameter is ignored.

    The total API response time may be higher than this value due to internal processing. Set your HTTP client timeout to a value greater than this parameter.

    Valid range: 1 to 15 seconds.

    Default value: 5 seconds.

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

    The message body. MQTT accepts text, binary, and empty (null) message payloads.

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

    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.

    For MQTT 3.1.1 clients, user properties are silently dropped.

    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: false
    

    An Enum string value that indicates whether the payload is formatted as UTF-8. payloadFormatIndicator is an HTTP header value in the API.

    
    
  • correlation_data(impl Into<String>) / set_correlation_data(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with SendDirectMessageOutput with field(s):
  • message(Option<String>):

    The status message indicating the result of the operation.

  • trace_id(Option<String>):

    A unique identifier for the request. Include this value when contacting Amazon Web Services Support for troubleshooting.

• On failure, responds with SdkError<SendDirectMessageError>

impl Client

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: true
    

    The name of the thing.

    
    
  • shadow_name(impl Into<String>) / set_shadow_name(Option<String>):
    required: false
    

    The name of the shadow.

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

    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 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 and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

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.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

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