aws_sdk_lexmodelsv2/
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 Amazon Lex Model Building V2
10///
11/// Client for invoking operations on Amazon Lex Model Building V2. Each operation on Amazon Lex Model Building V2 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_lexmodelsv2::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_lexmodelsv2::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/// # Using the `Client`
60///
61/// A client has a function for every operation that can be performed by the service.
62/// For example, the [`BatchCreateCustomVocabularyItem`](crate::operation::batch_create_custom_vocabulary_item) operation has
63/// a [`Client::batch_create_custom_vocabulary_item`], function which returns a builder for that operation.
64/// The fluent builder ultimately has a `send()` function that returns an async future that
65/// returns a result, as illustrated below:
66///
67/// ```rust,ignore
68/// let result = client.batch_create_custom_vocabulary_item()
69///     .bot_id("example")
70///     .send()
71///     .await;
72/// ```
73///
74/// The underlying HTTP requests that get made by this can be modified with the `customize_operation`
75/// function on the fluent builder. See the [`customize`](crate::client::customize) module for more
76/// information.
77/// # Waiters
78///
79/// This client provides `wait_until` methods behind the [`Waiters`](crate::client::Waiters) trait.
80/// To use them, simply import the trait, and then call one of the `wait_until` methods. This will
81/// return a waiter fluent builder that takes various parameters, which are documented on the builder
82/// type. Once parameters have been provided, the `wait` method can be called to initiate waiting.
83///
84/// For example, if there was a `wait_until_thing` method, it could look like:
85/// ```rust,ignore
86/// let result = client.wait_until_thing()
87///     .thing_id("someId")
88///     .wait(Duration::from_secs(120))
89///     .await;
90/// ```
91#[derive(::std::clone::Clone, ::std::fmt::Debug)]
92pub struct Client {
93    handle: ::std::sync::Arc<Handle>,
94}
95
96impl Client {
97    /// Creates a new client from the service [`Config`](crate::Config).
98    ///
99    /// # Panics
100    ///
101    /// This method will panic in the following cases:
102    ///
103    /// - Retries or timeouts are enabled without a `sleep_impl` configured.
104    /// - Identity caching is enabled without a `sleep_impl` and `time_source` configured.
105    /// - No `behavior_version` is provided.
106    ///
107    /// The panic message for each of these will have instructions on how to resolve them.
108    #[track_caller]
109    pub fn from_conf(conf: crate::Config) -> Self {
110        let handle = Handle {
111            conf: conf.clone(),
112            runtime_plugins: crate::config::base_client_runtime_plugins(conf),
113        };
114        if let Err(err) = Self::validate_config(&handle) {
115            panic!("Invalid client configuration: {err}");
116        }
117        Self {
118            handle: ::std::sync::Arc::new(handle),
119        }
120    }
121
122    /// Returns the client's configuration.
123    pub fn config(&self) -> &crate::Config {
124        &self.handle.conf
125    }
126
127    fn validate_config(handle: &Handle) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
128        let mut cfg = ::aws_smithy_types::config_bag::ConfigBag::base();
129        handle
130            .runtime_plugins
131            .apply_client_configuration(&mut cfg)?
132            .validate_base_client_config(&cfg)?;
133        Ok(())
134    }
135}
136
137///
138/// Waiter functions for the client.
139///
140/// Import this trait to get `wait_until` methods on the client.
141///
142pub trait Waiters {
143    /// Wait until a bot is available
144    fn wait_until_bot_available(&self) -> crate::waiters::bot_available::BotAvailableFluentBuilder;
145    /// Wait until a bot alias is available
146    fn wait_until_bot_alias_available(&self) -> crate::waiters::bot_alias_available::BotAliasAvailableFluentBuilder;
147    /// Wait until a bot locale is built
148    fn wait_until_bot_locale_built(&self) -> crate::waiters::bot_locale_built::BotLocaleBuiltFluentBuilder;
149    /// Wait unit a bot locale is created
150    fn wait_until_bot_locale_created(&self) -> crate::waiters::bot_locale_created::BotLocaleCreatedFluentBuilder;
151    /// Wait until a bot locale build is ready for express testing
152    fn wait_until_bot_locale_express_testing_available(
153        &self,
154    ) -> crate::waiters::bot_locale_express_testing_available::BotLocaleExpressTestingAvailableFluentBuilder;
155    /// Wait until a bot version is available
156    fn wait_until_bot_version_available(&self) -> crate::waiters::bot_version_available::BotVersionAvailableFluentBuilder;
157    /// Wait until a bot has been exported
158    fn wait_until_bot_export_completed(&self) -> crate::waiters::bot_export_completed::BotExportCompletedFluentBuilder;
159    /// Wait until a bot has been imported
160    fn wait_until_bot_import_completed(&self) -> crate::waiters::bot_import_completed::BotImportCompletedFluentBuilder;
161}
162impl Waiters for Client {
163    fn wait_until_bot_available(&self) -> crate::waiters::bot_available::BotAvailableFluentBuilder {
164        crate::waiters::bot_available::BotAvailableFluentBuilder::new(self.handle.clone())
165    }
166    fn wait_until_bot_alias_available(&self) -> crate::waiters::bot_alias_available::BotAliasAvailableFluentBuilder {
167        crate::waiters::bot_alias_available::BotAliasAvailableFluentBuilder::new(self.handle.clone())
168    }
169    fn wait_until_bot_locale_built(&self) -> crate::waiters::bot_locale_built::BotLocaleBuiltFluentBuilder {
170        crate::waiters::bot_locale_built::BotLocaleBuiltFluentBuilder::new(self.handle.clone())
171    }
172    fn wait_until_bot_locale_created(&self) -> crate::waiters::bot_locale_created::BotLocaleCreatedFluentBuilder {
173        crate::waiters::bot_locale_created::BotLocaleCreatedFluentBuilder::new(self.handle.clone())
174    }
175    fn wait_until_bot_locale_express_testing_available(
176        &self,
177    ) -> crate::waiters::bot_locale_express_testing_available::BotLocaleExpressTestingAvailableFluentBuilder {
178        crate::waiters::bot_locale_express_testing_available::BotLocaleExpressTestingAvailableFluentBuilder::new(self.handle.clone())
179    }
180    fn wait_until_bot_version_available(&self) -> crate::waiters::bot_version_available::BotVersionAvailableFluentBuilder {
181        crate::waiters::bot_version_available::BotVersionAvailableFluentBuilder::new(self.handle.clone())
182    }
183    fn wait_until_bot_export_completed(&self) -> crate::waiters::bot_export_completed::BotExportCompletedFluentBuilder {
184        crate::waiters::bot_export_completed::BotExportCompletedFluentBuilder::new(self.handle.clone())
185    }
186    fn wait_until_bot_import_completed(&self) -> crate::waiters::bot_import_completed::BotImportCompletedFluentBuilder {
187        crate::waiters::bot_import_completed::BotImportCompletedFluentBuilder::new(self.handle.clone())
188    }
189}
190
191impl Client {
192    /// Creates a new client from an [SDK Config](::aws_types::sdk_config::SdkConfig).
193    ///
194    /// # Panics
195    ///
196    /// - This method will panic if the `sdk_config` is missing an async sleep implementation. If you experience this panic, set
197    ///   the `sleep_impl` on the Config passed into this function to fix it.
198    /// - This method will panic if the `sdk_config` is missing an HTTP connector. If you experience this panic, set the
199    ///   `http_connector` on the Config passed into this function to fix it.
200    /// - 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.
201    #[track_caller]
202    pub fn new(sdk_config: &::aws_types::sdk_config::SdkConfig) -> Self {
203        Self::from_conf(sdk_config.into())
204    }
205}
206
207mod batch_create_custom_vocabulary_item;
208
209mod batch_delete_custom_vocabulary_item;
210
211mod batch_update_custom_vocabulary_item;
212
213mod build_bot_locale;
214
215mod create_bot;
216
217mod create_bot_alias;
218
219mod create_bot_locale;
220
221mod create_bot_replica;
222
223mod create_bot_version;
224
225mod create_export;
226
227mod create_intent;
228
229mod create_resource_policy;
230
231mod create_resource_policy_statement;
232
233mod create_slot;
234
235mod create_slot_type;
236
237mod create_test_set_discrepancy_report;
238
239mod create_upload_url;
240
241/// Operation customization and supporting types.
242///
243/// The underlying HTTP requests made during an operation can be customized
244/// by calling the `customize()` method on the builder returned from a client
245/// operation call. For example, this can be used to add an additional HTTP header:
246///
247/// ```ignore
248/// # async fn wrapper() -> ::std::result::Result<(), aws_sdk_lexmodelsv2::Error> {
249/// # let client: aws_sdk_lexmodelsv2::Client = unimplemented!();
250/// use ::http::header::{HeaderName, HeaderValue};
251///
252/// let result = client.batch_create_custom_vocabulary_item()
253///     .customize()
254///     .mutate_request(|req| {
255///         // Add `x-example-header` with value
256///         req.headers_mut()
257///             .insert(
258///                 HeaderName::from_static("x-example-header"),
259///                 HeaderValue::from_static("1"),
260///             );
261///     })
262///     .send()
263///     .await;
264/// # }
265/// ```
266pub mod customize;
267
268mod delete_bot;
269
270mod delete_bot_alias;
271
272mod delete_bot_locale;
273
274mod delete_bot_replica;
275
276mod delete_bot_version;
277
278mod delete_custom_vocabulary;
279
280mod delete_export;
281
282mod delete_import;
283
284mod delete_intent;
285
286mod delete_resource_policy;
287
288mod delete_resource_policy_statement;
289
290mod delete_slot;
291
292mod delete_slot_type;
293
294mod delete_test_set;
295
296mod delete_utterances;
297
298mod describe_bot;
299
300mod describe_bot_alias;
301
302mod describe_bot_locale;
303
304mod describe_bot_recommendation;
305
306mod describe_bot_replica;
307
308mod describe_bot_resource_generation;
309
310mod describe_bot_version;
311
312mod describe_custom_vocabulary_metadata;
313
314mod describe_export;
315
316mod describe_import;
317
318mod describe_intent;
319
320mod describe_resource_policy;
321
322mod describe_slot;
323
324mod describe_slot_type;
325
326mod describe_test_execution;
327
328mod describe_test_set;
329
330mod describe_test_set_discrepancy_report;
331
332mod describe_test_set_generation;
333
334mod generate_bot_element;
335
336mod get_test_execution_artifacts_url;
337
338mod list_aggregated_utterances;
339
340mod list_bot_alias_replicas;
341
342mod list_bot_aliases;
343
344mod list_bot_locales;
345
346mod list_bot_recommendations;
347
348mod list_bot_replicas;
349
350mod list_bot_resource_generations;
351
352mod list_bot_version_replicas;
353
354mod list_bot_versions;
355
356mod list_bots;
357
358mod list_built_in_intents;
359
360mod list_built_in_slot_types;
361
362mod list_custom_vocabulary_items;
363
364mod list_exports;
365
366mod list_imports;
367
368mod list_intent_metrics;
369
370mod list_intent_paths;
371
372mod list_intent_stage_metrics;
373
374mod list_intents;
375
376mod list_recommended_intents;
377
378mod list_session_analytics_data;
379
380mod list_session_metrics;
381
382mod list_slot_types;
383
384mod list_slots;
385
386mod list_tags_for_resource;
387
388mod list_test_execution_result_items;
389
390mod list_test_executions;
391
392mod list_test_set_records;
393
394mod list_test_sets;
395
396mod list_utterance_analytics_data;
397
398mod list_utterance_metrics;
399
400mod search_associated_transcripts;
401
402mod start_bot_recommendation;
403
404mod start_bot_resource_generation;
405
406mod start_import;
407
408mod start_test_execution;
409
410mod start_test_set_generation;
411
412mod stop_bot_recommendation;
413
414mod tag_resource;
415
416mod untag_resource;
417
418mod update_bot;
419
420mod update_bot_alias;
421
422mod update_bot_locale;
423
424mod update_bot_recommendation;
425
426mod update_export;
427
428mod update_intent;
429
430mod update_resource_policy;
431
432mod update_slot;
433
434mod update_slot_type;
435
436mod update_test_set;