aws_sdk_dynamodb/client.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2#[derive(Debug)]
3 pub(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 DynamoDB
10 ///
11 /// Client for invoking operations on Amazon DynamoDB. Each operation on Amazon DynamoDB 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_dynamodb::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_dynamodb::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 [`BatchExecuteStatement`](crate::operation::batch_execute_statement) operation has
63/// a [`Client::batch_execute_statement`], 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_execute_statement()
69/// .return_consumed_capacity("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)]
92 pub struct Client {
93 handle: ::std::sync::Arc<Handle>,
94 }
95
96 impl 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.runtime_plugins
130 .apply_client_configuration(&mut cfg)?
131 .validate_base_client_config(&cfg)?;
132 Ok(())
133 }
134 }
135
136///
137/// Waiter functions for the client.
138///
139/// Import this trait to get `wait_until` methods on the client.
140///
141pub trait Waiters {
142 /// Wait for `table_exists`
143 fn wait_until_table_exists(&self) -> crate::waiters::table_exists::TableExistsFluentBuilder
144 ;
145 /// Wait for `table_not_exists`
146 fn wait_until_table_not_exists(&self) -> crate::waiters::table_not_exists::TableNotExistsFluentBuilder
147 ;
148}
149impl Waiters for Client {
150 fn wait_until_table_exists(&self) -> crate::waiters::table_exists::TableExistsFluentBuilder
151 { crate::waiters::table_exists::TableExistsFluentBuilder::new(self.handle.clone()) }
152 fn wait_until_table_not_exists(&self) -> crate::waiters::table_not_exists::TableNotExistsFluentBuilder
153 { crate::waiters::table_not_exists::TableNotExistsFluentBuilder::new(self.handle.clone()) }
154}
155
156impl Client {
157 /// Creates a new client from an [SDK Config](::aws_types::sdk_config::SdkConfig).
158 ///
159 /// # Panics
160 ///
161 /// - This method will panic if the `sdk_config` is missing an async sleep implementation. If you experience this panic, set
162 /// the `sleep_impl` on the Config passed into this function to fix it.
163 /// - This method will panic if the `sdk_config` is missing an HTTP connector. If you experience this panic, set the
164 /// `http_connector` on the Config passed into this function to fix it.
165 /// - 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.
166 #[track_caller]
167 pub fn new(sdk_config: &::aws_types::sdk_config::SdkConfig) -> Self {
168 Self::from_conf(sdk_config.into())
169 }
170}
171
172mod batch_execute_statement;
173
174mod batch_get_item;
175
176mod batch_write_item;
177
178mod create_backup;
179
180mod create_global_table;
181
182mod create_table;
183
184/// Operation customization and supporting types.
185///
186/// The underlying HTTP requests made during an operation can be customized
187/// by calling the `customize()` method on the builder returned from a client
188/// operation call. For example, this can be used to add an additional HTTP header:
189///
190/// ```ignore
191/// # async fn wrapper() -> ::std::result::Result<(), aws_sdk_dynamodb::Error> {
192/// # let client: aws_sdk_dynamodb::Client = unimplemented!();
193/// use ::http::header::{HeaderName, HeaderValue};
194///
195/// let result = client.batch_execute_statement()
196/// .customize()
197/// .mutate_request(|req| {
198/// // Add `x-example-header` with value
199/// req.headers_mut()
200/// .insert(
201/// HeaderName::from_static("x-example-header"),
202/// HeaderValue::from_static("1"),
203/// );
204/// })
205/// .send()
206/// .await;
207/// # }
208/// ```
209pub mod customize;
210
211mod delete_backup;
212
213mod delete_item;
214
215mod delete_resource_policy;
216
217mod delete_table;
218
219mod describe_backup;
220
221mod describe_continuous_backups;
222
223mod describe_contributor_insights;
224
225mod describe_endpoints;
226
227mod describe_export;
228
229mod describe_global_table;
230
231mod describe_global_table_settings;
232
233mod describe_import;
234
235mod describe_kinesis_streaming_destination;
236
237mod describe_limits;
238
239mod describe_table;
240
241mod describe_table_replica_auto_scaling;
242
243mod describe_time_to_live;
244
245mod disable_kinesis_streaming_destination;
246
247mod enable_kinesis_streaming_destination;
248
249mod execute_statement;
250
251mod execute_transaction;
252
253mod export_table_to_point_in_time;
254
255mod get_item;
256
257mod get_resource_policy;
258
259mod import_table;
260
261mod list_backups;
262
263mod list_contributor_insights;
264
265mod list_exports;
266
267mod list_global_tables;
268
269mod list_imports;
270
271mod list_tables;
272
273mod list_tags_of_resource;
274
275mod put_item;
276
277mod put_resource_policy;
278
279mod query;
280
281mod restore_table_from_backup;
282
283mod restore_table_to_point_in_time;
284
285mod scan;
286
287mod tag_resource;
288
289mod transact_get_items;
290
291mod transact_write_items;
292
293mod untag_resource;
294
295mod update_continuous_backups;
296
297mod update_contributor_insights;
298
299mod update_global_table;
300
301mod update_global_table_settings;
302
303mod update_item;
304
305mod update_kinesis_streaming_destination;
306
307mod update_table;
308
309mod update_table_replica_auto_scaling;
310
311mod update_time_to_live;
312