aws_sdk_medialive/
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 Elemental MediaLive
10///
11/// Client for invoking operations on AWS Elemental MediaLive. Each operation on AWS Elemental MediaLive 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_medialive::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_medialive::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 [`AcceptInputDeviceTransfer`](crate::operation::accept_input_device_transfer) operation has
63/// a [`Client::accept_input_device_transfer`], 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.accept_input_device_transfer()
69///     .input_device_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 channel has been created
144    fn wait_until_channel_created(&self) -> crate::waiters::channel_created::ChannelCreatedFluentBuilder;
145    /// Wait until a channel has been deleted
146    fn wait_until_channel_deleted(&self) -> crate::waiters::channel_deleted::ChannelDeletedFluentBuilder;
147    /// Wait until a channel is running
148    fn wait_until_channel_running(&self) -> crate::waiters::channel_running::ChannelRunningFluentBuilder;
149    /// Wait until a channel has is stopped
150    fn wait_until_channel_stopped(&self) -> crate::waiters::channel_stopped::ChannelStoppedFluentBuilder;
151    /// Wait until the channel placement group has been assigned
152    fn wait_until_channel_placement_group_assigned(
153        &self,
154    ) -> crate::waiters::channel_placement_group_assigned::ChannelPlacementGroupAssignedFluentBuilder;
155    /// Wait until the channel placement group has been deleted
156    fn wait_until_channel_placement_group_deleted(
157        &self,
158    ) -> crate::waiters::channel_placement_group_deleted::ChannelPlacementGroupDeletedFluentBuilder;
159    /// Wait until the channel placement group has been unassigned
160    fn wait_until_channel_placement_group_unassigned(
161        &self,
162    ) -> crate::waiters::channel_placement_group_unassigned::ChannelPlacementGroupUnassignedFluentBuilder;
163    /// Wait until a cluster has been created
164    fn wait_until_cluster_created(&self) -> crate::waiters::cluster_created::ClusterCreatedFluentBuilder;
165    /// Wait until a cluster has been deleted
166    fn wait_until_cluster_deleted(&self) -> crate::waiters::cluster_deleted::ClusterDeletedFluentBuilder;
167    /// Wait until an input has been attached
168    fn wait_until_input_attached(&self) -> crate::waiters::input_attached::InputAttachedFluentBuilder;
169    /// Wait until an input has been deleted
170    fn wait_until_input_deleted(&self) -> crate::waiters::input_deleted::InputDeletedFluentBuilder;
171    /// Wait until an input has been detached
172    fn wait_until_input_detached(&self) -> crate::waiters::input_detached::InputDetachedFluentBuilder;
173    /// Wait until a multiplex has been created
174    fn wait_until_multiplex_created(&self) -> crate::waiters::multiplex_created::MultiplexCreatedFluentBuilder;
175    /// Wait until a multiplex has been deleted
176    fn wait_until_multiplex_deleted(&self) -> crate::waiters::multiplex_deleted::MultiplexDeletedFluentBuilder;
177    /// Wait until a multiplex is running
178    fn wait_until_multiplex_running(&self) -> crate::waiters::multiplex_running::MultiplexRunningFluentBuilder;
179    /// Wait until a multiplex has is stopped
180    fn wait_until_multiplex_stopped(&self) -> crate::waiters::multiplex_stopped::MultiplexStoppedFluentBuilder;
181    /// Wait until a node has been deregistered
182    fn wait_until_node_deregistered(&self) -> crate::waiters::node_deregistered::NodeDeregisteredFluentBuilder;
183    /// Wait until a node has been registered
184    fn wait_until_node_registered(&self) -> crate::waiters::node_registered::NodeRegisteredFluentBuilder;
185    /// Wait until a signal map has been created
186    fn wait_until_signal_map_created(&self) -> crate::waiters::signal_map_created::SignalMapCreatedFluentBuilder;
187    /// Wait until a signal map's monitor has been deleted
188    fn wait_until_signal_map_monitor_deleted(&self) -> crate::waiters::signal_map_monitor_deleted::SignalMapMonitorDeletedFluentBuilder;
189    /// Wait until a signal map's monitor has been deployed
190    fn wait_until_signal_map_monitor_deployed(&self) -> crate::waiters::signal_map_monitor_deployed::SignalMapMonitorDeployedFluentBuilder;
191    /// Wait until a signal map has been updated
192    fn wait_until_signal_map_updated(&self) -> crate::waiters::signal_map_updated::SignalMapUpdatedFluentBuilder;
193}
194impl Waiters for Client {
195    fn wait_until_channel_created(&self) -> crate::waiters::channel_created::ChannelCreatedFluentBuilder {
196        crate::waiters::channel_created::ChannelCreatedFluentBuilder::new(self.handle.clone())
197    }
198    fn wait_until_channel_deleted(&self) -> crate::waiters::channel_deleted::ChannelDeletedFluentBuilder {
199        crate::waiters::channel_deleted::ChannelDeletedFluentBuilder::new(self.handle.clone())
200    }
201    fn wait_until_channel_running(&self) -> crate::waiters::channel_running::ChannelRunningFluentBuilder {
202        crate::waiters::channel_running::ChannelRunningFluentBuilder::new(self.handle.clone())
203    }
204    fn wait_until_channel_stopped(&self) -> crate::waiters::channel_stopped::ChannelStoppedFluentBuilder {
205        crate::waiters::channel_stopped::ChannelStoppedFluentBuilder::new(self.handle.clone())
206    }
207    fn wait_until_channel_placement_group_assigned(
208        &self,
209    ) -> crate::waiters::channel_placement_group_assigned::ChannelPlacementGroupAssignedFluentBuilder {
210        crate::waiters::channel_placement_group_assigned::ChannelPlacementGroupAssignedFluentBuilder::new(self.handle.clone())
211    }
212    fn wait_until_channel_placement_group_deleted(
213        &self,
214    ) -> crate::waiters::channel_placement_group_deleted::ChannelPlacementGroupDeletedFluentBuilder {
215        crate::waiters::channel_placement_group_deleted::ChannelPlacementGroupDeletedFluentBuilder::new(self.handle.clone())
216    }
217    fn wait_until_channel_placement_group_unassigned(
218        &self,
219    ) -> crate::waiters::channel_placement_group_unassigned::ChannelPlacementGroupUnassignedFluentBuilder {
220        crate::waiters::channel_placement_group_unassigned::ChannelPlacementGroupUnassignedFluentBuilder::new(self.handle.clone())
221    }
222    fn wait_until_cluster_created(&self) -> crate::waiters::cluster_created::ClusterCreatedFluentBuilder {
223        crate::waiters::cluster_created::ClusterCreatedFluentBuilder::new(self.handle.clone())
224    }
225    fn wait_until_cluster_deleted(&self) -> crate::waiters::cluster_deleted::ClusterDeletedFluentBuilder {
226        crate::waiters::cluster_deleted::ClusterDeletedFluentBuilder::new(self.handle.clone())
227    }
228    fn wait_until_input_attached(&self) -> crate::waiters::input_attached::InputAttachedFluentBuilder {
229        crate::waiters::input_attached::InputAttachedFluentBuilder::new(self.handle.clone())
230    }
231    fn wait_until_input_deleted(&self) -> crate::waiters::input_deleted::InputDeletedFluentBuilder {
232        crate::waiters::input_deleted::InputDeletedFluentBuilder::new(self.handle.clone())
233    }
234    fn wait_until_input_detached(&self) -> crate::waiters::input_detached::InputDetachedFluentBuilder {
235        crate::waiters::input_detached::InputDetachedFluentBuilder::new(self.handle.clone())
236    }
237    fn wait_until_multiplex_created(&self) -> crate::waiters::multiplex_created::MultiplexCreatedFluentBuilder {
238        crate::waiters::multiplex_created::MultiplexCreatedFluentBuilder::new(self.handle.clone())
239    }
240    fn wait_until_multiplex_deleted(&self) -> crate::waiters::multiplex_deleted::MultiplexDeletedFluentBuilder {
241        crate::waiters::multiplex_deleted::MultiplexDeletedFluentBuilder::new(self.handle.clone())
242    }
243    fn wait_until_multiplex_running(&self) -> crate::waiters::multiplex_running::MultiplexRunningFluentBuilder {
244        crate::waiters::multiplex_running::MultiplexRunningFluentBuilder::new(self.handle.clone())
245    }
246    fn wait_until_multiplex_stopped(&self) -> crate::waiters::multiplex_stopped::MultiplexStoppedFluentBuilder {
247        crate::waiters::multiplex_stopped::MultiplexStoppedFluentBuilder::new(self.handle.clone())
248    }
249    fn wait_until_node_deregistered(&self) -> crate::waiters::node_deregistered::NodeDeregisteredFluentBuilder {
250        crate::waiters::node_deregistered::NodeDeregisteredFluentBuilder::new(self.handle.clone())
251    }
252    fn wait_until_node_registered(&self) -> crate::waiters::node_registered::NodeRegisteredFluentBuilder {
253        crate::waiters::node_registered::NodeRegisteredFluentBuilder::new(self.handle.clone())
254    }
255    fn wait_until_signal_map_created(&self) -> crate::waiters::signal_map_created::SignalMapCreatedFluentBuilder {
256        crate::waiters::signal_map_created::SignalMapCreatedFluentBuilder::new(self.handle.clone())
257    }
258    fn wait_until_signal_map_monitor_deleted(&self) -> crate::waiters::signal_map_monitor_deleted::SignalMapMonitorDeletedFluentBuilder {
259        crate::waiters::signal_map_monitor_deleted::SignalMapMonitorDeletedFluentBuilder::new(self.handle.clone())
260    }
261    fn wait_until_signal_map_monitor_deployed(&self) -> crate::waiters::signal_map_monitor_deployed::SignalMapMonitorDeployedFluentBuilder {
262        crate::waiters::signal_map_monitor_deployed::SignalMapMonitorDeployedFluentBuilder::new(self.handle.clone())
263    }
264    fn wait_until_signal_map_updated(&self) -> crate::waiters::signal_map_updated::SignalMapUpdatedFluentBuilder {
265        crate::waiters::signal_map_updated::SignalMapUpdatedFluentBuilder::new(self.handle.clone())
266    }
267}
268
269impl Client {
270    /// Creates a new client from an [SDK Config](::aws_types::sdk_config::SdkConfig).
271    ///
272    /// # Panics
273    ///
274    /// - This method will panic if the `sdk_config` is missing an async sleep implementation. If you experience this panic, set
275    ///   the `sleep_impl` on the Config passed into this function to fix it.
276    /// - This method will panic if the `sdk_config` is missing an HTTP connector. If you experience this panic, set the
277    ///   `http_connector` on the Config passed into this function to fix it.
278    /// - 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.
279    #[track_caller]
280    pub fn new(sdk_config: &::aws_types::sdk_config::SdkConfig) -> Self {
281        Self::from_conf(sdk_config.into())
282    }
283}
284
285mod accept_input_device_transfer;
286
287mod batch_delete;
288
289mod batch_start;
290
291mod batch_stop;
292
293mod batch_update_schedule;
294
295mod cancel_input_device_transfer;
296
297mod claim_device;
298
299mod create_channel;
300
301mod create_channel_placement_group;
302
303mod create_cloud_watch_alarm_template;
304
305mod create_cloud_watch_alarm_template_group;
306
307mod create_cluster;
308
309mod create_event_bridge_rule_template;
310
311mod create_event_bridge_rule_template_group;
312
313mod create_input;
314
315mod create_input_security_group;
316
317mod create_multiplex;
318
319mod create_multiplex_program;
320
321mod create_network;
322
323mod create_node;
324
325mod create_node_registration_script;
326
327mod create_partner_input;
328
329mod create_sdi_source;
330
331mod create_signal_map;
332
333mod create_tags;
334
335/// Operation customization and supporting types.
336///
337/// The underlying HTTP requests made during an operation can be customized
338/// by calling the `customize()` method on the builder returned from a client
339/// operation call. For example, this can be used to add an additional HTTP header:
340///
341/// ```ignore
342/// # async fn wrapper() -> ::std::result::Result<(), aws_sdk_medialive::Error> {
343/// # let client: aws_sdk_medialive::Client = unimplemented!();
344/// use ::http::header::{HeaderName, HeaderValue};
345///
346/// let result = client.accept_input_device_transfer()
347///     .customize()
348///     .mutate_request(|req| {
349///         // Add `x-example-header` with value
350///         req.headers_mut()
351///             .insert(
352///                 HeaderName::from_static("x-example-header"),
353///                 HeaderValue::from_static("1"),
354///             );
355///     })
356///     .send()
357///     .await;
358/// # }
359/// ```
360pub mod customize;
361
362mod delete_channel;
363
364mod delete_channel_placement_group;
365
366mod delete_cloud_watch_alarm_template;
367
368mod delete_cloud_watch_alarm_template_group;
369
370mod delete_cluster;
371
372mod delete_event_bridge_rule_template;
373
374mod delete_event_bridge_rule_template_group;
375
376mod delete_input;
377
378mod delete_input_security_group;
379
380mod delete_multiplex;
381
382mod delete_multiplex_program;
383
384mod delete_network;
385
386mod delete_node;
387
388mod delete_reservation;
389
390mod delete_schedule;
391
392mod delete_sdi_source;
393
394mod delete_signal_map;
395
396mod delete_tags;
397
398mod describe_account_configuration;
399
400mod describe_channel;
401
402mod describe_channel_placement_group;
403
404mod describe_cluster;
405
406mod describe_input;
407
408mod describe_input_device;
409
410mod describe_input_device_thumbnail;
411
412mod describe_input_security_group;
413
414mod describe_multiplex;
415
416mod describe_multiplex_program;
417
418mod describe_network;
419
420mod describe_node;
421
422mod describe_offering;
423
424mod describe_reservation;
425
426mod describe_schedule;
427
428mod describe_sdi_source;
429
430mod describe_thumbnails;
431
432mod get_cloud_watch_alarm_template;
433
434mod get_cloud_watch_alarm_template_group;
435
436mod get_event_bridge_rule_template;
437
438mod get_event_bridge_rule_template_group;
439
440mod get_signal_map;
441
442mod list_alerts;
443
444mod list_channel_placement_groups;
445
446mod list_channels;
447
448mod list_cloud_watch_alarm_template_groups;
449
450mod list_cloud_watch_alarm_templates;
451
452mod list_cluster_alerts;
453
454mod list_clusters;
455
456mod list_event_bridge_rule_template_groups;
457
458mod list_event_bridge_rule_templates;
459
460mod list_input_device_transfers;
461
462mod list_input_devices;
463
464mod list_input_security_groups;
465
466mod list_inputs;
467
468mod list_multiplex_alerts;
469
470mod list_multiplex_programs;
471
472mod list_multiplexes;
473
474mod list_networks;
475
476mod list_nodes;
477
478mod list_offerings;
479
480mod list_reservations;
481
482mod list_sdi_sources;
483
484mod list_signal_maps;
485
486mod list_tags_for_resource;
487
488mod list_versions;
489
490mod purchase_offering;
491
492mod reboot_input_device;
493
494mod reject_input_device_transfer;
495
496mod restart_channel_pipelines;
497
498mod start_channel;
499
500mod start_delete_monitor_deployment;
501
502mod start_input_device;
503
504mod start_input_device_maintenance_window;
505
506mod start_monitor_deployment;
507
508mod start_multiplex;
509
510mod start_update_signal_map;
511
512mod stop_channel;
513
514mod stop_input_device;
515
516mod stop_multiplex;
517
518mod transfer_input_device;
519
520mod update_account_configuration;
521
522mod update_channel;
523
524mod update_channel_class;
525
526mod update_channel_placement_group;
527
528mod update_cloud_watch_alarm_template;
529
530mod update_cloud_watch_alarm_template_group;
531
532mod update_cluster;
533
534mod update_event_bridge_rule_template;
535
536mod update_event_bridge_rule_template_group;
537
538mod update_input;
539
540mod update_input_device;
541
542mod update_input_security_group;
543
544mod update_multiplex;
545
546mod update_multiplex_program;
547
548mod update_network;
549
550mod update_node;
551
552mod update_node_state;
553
554mod update_reservation;
555
556mod update_sdi_source;
aws_sdk_medialive/client.rs

aws_sdk_medialive/
client.rs
