aws_sdk_repostspace/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 AWS re:Post Private
10///
11/// Client for invoking operations on AWS re:Post Private. Each operation on AWS re:Post Private 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_repostspace::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_repostspace::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 [`BatchAddChannelRoleToAccessors`](crate::operation::batch_add_channel_role_to_accessors) operation has
63/// a [`Client::batch_add_channel_role_to_accessors`], 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_add_channel_role_to_accessors()
69/// .space_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 for `channel_created`
144 fn wait_until_channel_created(&self) -> crate::waiters::channel_created::ChannelCreatedFluentBuilder;
145 /// Wait for `channel_deleted`
146 fn wait_until_channel_deleted(&self) -> crate::waiters::channel_deleted::ChannelDeletedFluentBuilder;
147 /// Wait for `space_created`
148 fn wait_until_space_created(&self) -> crate::waiters::space_created::SpaceCreatedFluentBuilder;
149 /// Wait for `space_deleted`
150 fn wait_until_space_deleted(&self) -> crate::waiters::space_deleted::SpaceDeletedFluentBuilder;
151}
152impl Waiters for Client {
153 fn wait_until_channel_created(&self) -> crate::waiters::channel_created::ChannelCreatedFluentBuilder {
154 crate::waiters::channel_created::ChannelCreatedFluentBuilder::new(self.handle.clone())
155 }
156 fn wait_until_channel_deleted(&self) -> crate::waiters::channel_deleted::ChannelDeletedFluentBuilder {
157 crate::waiters::channel_deleted::ChannelDeletedFluentBuilder::new(self.handle.clone())
158 }
159 fn wait_until_space_created(&self) -> crate::waiters::space_created::SpaceCreatedFluentBuilder {
160 crate::waiters::space_created::SpaceCreatedFluentBuilder::new(self.handle.clone())
161 }
162 fn wait_until_space_deleted(&self) -> crate::waiters::space_deleted::SpaceDeletedFluentBuilder {
163 crate::waiters::space_deleted::SpaceDeletedFluentBuilder::new(self.handle.clone())
164 }
165}
166
167impl Client {
168 /// Creates a new client from an [SDK Config](::aws_types::sdk_config::SdkConfig).
169 ///
170 /// # Panics
171 ///
172 /// - This method will panic if the `sdk_config` is missing an async sleep implementation. If you experience this panic, set
173 /// the `sleep_impl` on the Config passed into this function to fix it.
174 /// - This method will panic if the `sdk_config` is missing an HTTP connector. If you experience this panic, set the
175 /// `http_connector` on the Config passed into this function to fix it.
176 /// - 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.
177 #[track_caller]
178 pub fn new(sdk_config: &::aws_types::sdk_config::SdkConfig) -> Self {
179 Self::from_conf(sdk_config.into())
180 }
181}
182
183mod batch_add_channel_role_to_accessors;
184
185mod batch_add_role;
186
187mod batch_remove_channel_role_from_accessors;
188
189mod batch_remove_role;
190
191mod create_channel;
192
193mod create_space;
194
195/// Operation customization and supporting types.
196///
197/// The underlying HTTP requests made during an operation can be customized
198/// by calling the `customize()` method on the builder returned from a client
199/// operation call. For example, this can be used to add an additional HTTP header:
200///
201/// ```ignore
202/// # async fn wrapper() -> ::std::result::Result<(), aws_sdk_repostspace::Error> {
203/// # let client: aws_sdk_repostspace::Client = unimplemented!();
204/// use ::http::header::{HeaderName, HeaderValue};
205///
206/// let result = client.batch_add_channel_role_to_accessors()
207/// .customize()
208/// .mutate_request(|req| {
209/// // Add `x-example-header` with value
210/// req.headers_mut()
211/// .insert(
212/// HeaderName::from_static("x-example-header"),
213/// HeaderValue::from_static("1"),
214/// );
215/// })
216/// .send()
217/// .await;
218/// # }
219/// ```
220pub mod customize;
221
222mod delete_space;
223
224mod deregister_admin;
225
226mod get_channel;
227
228mod get_space;
229
230mod list_channels;
231
232mod list_spaces;
233
234mod list_tags_for_resource;
235
236mod register_admin;
237
238mod send_invites;
239
240mod tag_resource;
241
242mod untag_resource;
243
244mod update_channel;
245
246mod update_space;