Struct aws_sdk_iot1clickdevices::Client

pub struct Client { /* private fields */ }

Client for AWS IoT 1-Click Devices Service

Client for invoking operations on AWS IoT 1-Click Devices Service. Each operation on AWS IoT 1-Click Devices Service 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_iot1clickdevices::Client::new(&config);

Occasionally, SDKs may have additional service-specific 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_iot1clickdevices::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 ClaimDevicesByClaimCode operation has a Client::claim_devices_by_claim_code, 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.claim_devices_by_claim_code()
    .claim_code("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 claim_devices_by_claim_code( &self ) -> ClaimDevicesByClaimCodeFluentBuilder

Constructs a fluent builder for the ClaimDevicesByClaimCode operation.

• The fluent builder is configurable:
  • claim_code(impl Into<String>) / set_claim_code(Option<String>):

    The claim code, starting with “C-”, as provided by the device manufacturer.

• On success, responds with ClaimDevicesByClaimCodeOutput with field(s):
  • claim_code(Option<String>):

    The claim code provided by the device manufacturer.

  • total(Option<i32>):

    The total number of devices associated with the claim code that has been processed in the claim request.

• On failure, responds with SdkError<ClaimDevicesByClaimCodeError>

impl Client

pub fn describe_device(&self) -> DescribeDeviceFluentBuilder

Constructs a fluent builder for the DescribeDevice operation.

• The fluent builder is configurable:
  • device_id(impl Into<String>) / set_device_id(Option<String>):

    The unique identifier of the device.

• On success, responds with DescribeDeviceOutput with field(s):
  • device_description(Option<DeviceDescription>):

    Device details.

• On failure, responds with SdkError<DescribeDeviceError>

impl Client

pub fn finalize_device_claim(&self) -> FinalizeDeviceClaimFluentBuilder

Constructs a fluent builder for the FinalizeDeviceClaim operation.

• The fluent builder is configurable:
  • device_id(impl Into<String>) / set_device_id(Option<String>):

    The unique identifier of the device.

  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap<String, String>>):

    A collection of key/value pairs defining the resource tags. For example, { “tags”: {“key1”: “value1”, “key2”: “value2”} }. For more information, see AWS Tagging Strategies.

• On success, responds with FinalizeDeviceClaimOutput with field(s):
  • state(Option<String>):

    The device’s final claim state.

• On failure, responds with SdkError<FinalizeDeviceClaimError>

impl Client

pub fn get_device_methods(&self) -> GetDeviceMethodsFluentBuilder

Constructs a fluent builder for the GetDeviceMethods operation.

• The fluent builder is configurable:
  • device_id(impl Into<String>) / set_device_id(Option<String>):

    The unique identifier of the device.

• On success, responds with GetDeviceMethodsOutput with field(s):
  • device_methods(Option<Vec<DeviceMethod>>):

    List of available device APIs.

• On failure, responds with SdkError<GetDeviceMethodsError>

impl Client

pub fn initiate_device_claim(&self) -> InitiateDeviceClaimFluentBuilder

Constructs a fluent builder for the InitiateDeviceClaim operation.

• The fluent builder is configurable:
  • device_id(impl Into<String>) / set_device_id(Option<String>):

    The unique identifier of the device.

• On success, responds with InitiateDeviceClaimOutput with field(s):
  • state(Option<String>):

    The device’s final claim state.

• On failure, responds with SdkError<InitiateDeviceClaimError>

impl Client

pub fn invoke_device_method(&self) -> InvokeDeviceMethodFluentBuilder

Constructs a fluent builder for the InvokeDeviceMethod operation.

• The fluent builder is configurable:
  • device_id(impl Into<String>) / set_device_id(Option<String>):

    The unique identifier of the device.

  • device_method(DeviceMethod) / set_device_method(Option<DeviceMethod>):

    The device method to invoke.

  • device_method_parameters(impl Into<String>) / set_device_method_parameters(Option<String>):

    A JSON encoded string containing the device method request parameters.

• On success, responds with InvokeDeviceMethodOutput with field(s):
  • device_method_response(Option<String>):

    A JSON encoded string containing the device method response.

• On failure, responds with SdkError<InvokeDeviceMethodError>

impl Client

pub fn list_device_events(&self) -> ListDeviceEventsFluentBuilder

Constructs a fluent builder for the ListDeviceEvents operation.

• The fluent builder is configurable:
  • device_id(impl Into<String>) / set_device_id(Option<String>):

    The unique identifier of the device.

  • from_time_stamp(DateTime) / set_from_time_stamp(Option<DateTime>):

    The start date for the device event query, in ISO8061 format. For example, 2018-03-28T15:45:12.880Z

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of results to return per request. If not set, a default value of 100 is used.

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

    The token to retrieve the next set of results.

  • to_time_stamp(DateTime) / set_to_time_stamp(Option<DateTime>):

    The end date for the device event query, in ISO8061 format. For example, 2018-03-28T15:45:12.880Z

• On success, responds with ListDeviceEventsOutput with field(s):
  • events(Option<Vec<DeviceEvent>>):

    An array of zero or more elements describing the event(s) associated with the device.

  • next_token(Option<String>):

    The token to retrieve the next set of results.

• On failure, responds with SdkError<ListDeviceEventsError>

impl Client

pub fn list_devices(&self) -> ListDevicesFluentBuilder

Constructs a fluent builder for the ListDevices operation.

• The fluent builder is configurable:
  • device_type(impl Into<String>) / set_device_type(Option<String>):

    The type of the device, such as “button”.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of results to return per request. If not set, a default value of 100 is used.

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

    The token to retrieve the next set of results.

• On success, responds with ListDevicesOutput with field(s):
  • devices(Option<Vec<DeviceDescription>>):

    A list of devices.

  • next_token(Option<String>):

    The token to retrieve the next set of results.

• On failure, responds with SdkError<ListDevicesError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    The ARN of the resource.

• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap<String, String>>):

    A collection of key/value pairs defining the resource tags. For example, { “tags”: {“key1”: “value1”, “key2”: “value2”} }. For more information, see AWS Tagging Strategies.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    The ARN of the resource.

  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap<String, String>>):

    A collection of key/value pairs defining the resource tags. For example, { “tags”: {“key1”: “value1”, “key2”: “value2”} }. For more information, see AWS Tagging Strategies.

• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn unclaim_device(&self) -> UnclaimDeviceFluentBuilder

Constructs a fluent builder for the UnclaimDevice operation.

• The fluent builder is configurable:
  • device_id(impl Into<String>) / set_device_id(Option<String>):

    The unique identifier of the device.

• On success, responds with UnclaimDeviceOutput with field(s):
  • state(Option<String>):

    The device’s final claim state.

• On failure, responds with SdkError<UnclaimDeviceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    The ARN of the resource.

  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec<String>>):

    A collections of tag keys. For example, {“key1”,“key2”}

• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_device_state(&self) -> UpdateDeviceStateFluentBuilder

Constructs a fluent builder for the UpdateDeviceState operation.

• The fluent builder is configurable:
  • device_id(impl Into<String>) / set_device_id(Option<String>):

    The unique identifier of the device.

  • enabled(bool) / set_enabled(Option<bool>):

    If true, the device is enabled. If false, the device is disabled.

• On success, responds with UpdateDeviceStateOutput
• On failure, responds with SdkError<UpdateDeviceStateError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic if the conf has retry or timeouts enabled without a sleep_impl. If you experience this panic, it can be fixed by setting the sleep_impl, or by disabling retries and timeouts.

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.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

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.