aws_sdk_iotmanagedintegrations/
client.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2#[derive(Debug)]
3pub(crate) struct Handle {
4    pub(crate) conf: crate::Config,
5    #[allow(dead_code)] // unused when a service does not provide any operations
6    pub(crate) runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
7}
8
9/// Client for Managed integrations for AWS IoT Device Management
10///
11/// Client for invoking operations on Managed integrations for AWS IoT Device Management. Each operation on Managed integrations for AWS IoT Device Management is a method on this
12/// this struct. `.send()` MUST be invoked on the generated operations to dispatch the request to the service.
13/// ## Constructing a `Client`
14///
15/// A [`Config`] is required to construct a client. For most use cases, the [`aws-config`]
16/// crate should be used to automatically resolve this config using
17/// [`aws_config::load_from_env()`], since this will resolve an [`SdkConfig`] which can be shared
18/// across multiple different AWS SDK clients. This config resolution process can be customized
19/// by calling [`aws_config::from_env()`] instead, which returns a [`ConfigLoader`] that uses
20/// the [builder pattern] to customize the default config.
21///
22/// In the simplest case, creating a client looks as follows:
23/// ```rust,no_run
24/// # async fn wrapper() {
25/// let config = aws_config::load_from_env().await;
26/// let client = aws_sdk_iotmanagedintegrations::Client::new(&config);
27/// # }
28/// ```
29///
30/// Occasionally, SDKs may have additional service-specific values that can be set on the [`Config`] that
31/// is absent from [`SdkConfig`], or slightly different settings for a specific client may be desired.
32/// The [`Builder`](crate::config::Builder) struct implements `From<&SdkConfig>`, so setting these specific settings can be
33/// done as follows:
34///
35/// ```rust,no_run
36/// # async fn wrapper() {
37/// let sdk_config = ::aws_config::load_from_env().await;
38/// let config = aws_sdk_iotmanagedintegrations::config::Builder::from(&sdk_config)
39/// # /*
40///     .some_service_specific_setting("value")
41/// # */
42///     .build();
43/// # }
44/// ```
45///
46/// See the [`aws-config` docs] and [`Config`] for more information on customizing configuration.
47///
48/// _Note:_ Client construction is expensive due to connection thread pool initialization, and should
49/// be done once at application start-up.
50///
51/// [`Config`]: crate::Config
52/// [`ConfigLoader`]: https://docs.rs/aws-config/*/aws_config/struct.ConfigLoader.html
53/// [`SdkConfig`]: https://docs.rs/aws-config/*/aws_config/struct.SdkConfig.html
54/// [`aws-config` docs]: https://docs.rs/aws-config/*
55/// [`aws-config`]: https://crates.io/crates/aws-config
56/// [`aws_config::from_env()`]: https://docs.rs/aws-config/*/aws_config/fn.from_env.html
57/// [`aws_config::load_from_env()`]: https://docs.rs/aws-config/*/aws_config/fn.load_from_env.html
58/// [builder pattern]: https://rust-lang.github.io/api-guidelines/type-safety.html#builders-enable-construction-of-complex-values-c-builder
59#[derive(::std::clone::Clone, ::std::fmt::Debug)]
60pub struct Client {
61    handle: ::std::sync::Arc<Handle>,
62}
63
64impl Client {
65    /// Creates a new client from the service [`Config`](crate::Config).
66    ///
67    /// # Panics
68    ///
69    /// This method will panic in the following cases:
70    ///
71    /// - Retries or timeouts are enabled without a `sleep_impl` configured.
72    /// - Identity caching is enabled without a `sleep_impl` and `time_source` configured.
73    /// - No `behavior_version` is provided.
74    ///
75    /// The panic message for each of these will have instructions on how to resolve them.
76    #[track_caller]
77    pub fn from_conf(conf: crate::Config) -> Self {
78        let handle = Handle {
79            conf: conf.clone(),
80            runtime_plugins: crate::config::base_client_runtime_plugins(conf),
81        };
82        if let Err(err) = Self::validate_config(&handle) {
83            panic!("Invalid client configuration: {err}");
84        }
85        Self {
86            handle: ::std::sync::Arc::new(handle),
87        }
88    }
89
90    /// Returns the client's configuration.
91    pub fn config(&self) -> &crate::Config {
92        &self.handle.conf
93    }
94
95    fn validate_config(handle: &Handle) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
96        let mut cfg = ::aws_smithy_types::config_bag::ConfigBag::base();
97        handle
98            .runtime_plugins
99            .apply_client_configuration(&mut cfg)?
100            .validate_base_client_config(&cfg)?;
101        Ok(())
102    }
103}
104
105impl Client {
106    /// Creates a new client from an [SDK Config](::aws_types::sdk_config::SdkConfig).
107    ///
108    /// # Panics
109    ///
110    /// - This method will panic if the `sdk_config` is missing an async sleep implementation. If you experience this panic, set
111    ///     the `sleep_impl` on the Config passed into this function to fix it.
112    /// - This method will panic if the `sdk_config` is missing an HTTP connector. If you experience this panic, set the
113    ///     `http_connector` on the Config passed into this function to fix it.
114    /// - 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.
115    #[track_caller]
116    pub fn new(sdk_config: &::aws_types::sdk_config::SdkConfig) -> Self {
117        Self::from_conf(sdk_config.into())
118    }
119}
120
121mod create_credential_locker;
122
123mod create_destination;
124
125mod create_event_log_configuration;
126
127mod create_managed_thing;
128
129mod create_notification_configuration;
130
131mod create_ota_task;
132
133mod create_ota_task_configuration;
134
135mod create_provisioning_profile;
136
137/// Operation customization and supporting types.
138///
139/// The underlying HTTP requests made during an operation can be customized
140/// by calling the `customize()` method on the builder returned from a client
141/// operation call. For example, this can be used to add an additional HTTP header:
142///
143/// ```ignore
144/// # async fn wrapper() -> ::std::result::Result<(), aws_sdk_iotmanagedintegrations::Error> {
145/// # let client: aws_sdk_iotmanagedintegrations::Client = unimplemented!();
146/// use ::http::header::{HeaderName, HeaderValue};
147///
148/// let result = client.get_custom_endpoint()
149///     .customize()
150///     .mutate_request(|req| {
151///         // Add `x-example-header` with value
152///         req.headers_mut()
153///             .insert(
154///                 HeaderName::from_static("x-example-header"),
155///                 HeaderValue::from_static("1"),
156///             );
157///     })
158///     .send()
159///     .await;
160/// # }
161/// ```
162pub mod customize;
163
164mod delete_credential_locker;
165
166mod delete_destination;
167
168mod delete_event_log_configuration;
169
170mod delete_managed_thing;
171
172mod delete_notification_configuration;
173
174mod delete_ota_task;
175
176mod delete_ota_task_configuration;
177
178mod delete_provisioning_profile;
179
180mod get_credential_locker;
181
182mod get_custom_endpoint;
183
184mod get_default_encryption_configuration;
185
186mod get_destination;
187
188mod get_device_discovery;
189
190mod get_event_log_configuration;
191
192mod get_hub_configuration;
193
194mod get_managed_thing;
195
196mod get_managed_thing_capabilities;
197
198mod get_managed_thing_connectivity_data;
199
200mod get_managed_thing_meta_data;
201
202mod get_managed_thing_state;
203
204mod get_notification_configuration;
205
206mod get_ota_task;
207
208mod get_ota_task_configuration;
209
210mod get_provisioning_profile;
211
212mod get_runtime_log_configuration;
213
214mod get_schema_version;
215
216mod list_credential_lockers;
217
218mod list_destinations;
219
220mod list_event_log_configurations;
221
222mod list_managed_thing_schemas;
223
224mod list_managed_things;
225
226mod list_notification_configurations;
227
228mod list_ota_task_configurations;
229
230mod list_ota_task_executions;
231
232mod list_ota_tasks;
233
234mod list_provisioning_profiles;
235
236mod list_schema_versions;
237
238mod put_default_encryption_configuration;
239
240mod put_hub_configuration;
241
242mod put_runtime_log_configuration;
243
244mod register_custom_endpoint;
245
246mod reset_runtime_log_configuration;
247
248mod send_managed_thing_command;
249
250mod start_device_discovery;
251
252mod update_destination;
253
254mod update_event_log_configuration;
255
256mod update_managed_thing;
257
258mod update_notification_configuration;
259
260mod update_ota_task;