aws_sdk_sts/
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 AWS Security Token Service
10                        ///
11                        /// Client for invoking operations on AWS Security Token Service. Each operation on AWS Security Token Service is a method on this
12                        /// this struct. `.send()` MUST be invoked on the generated operations to dispatch the request to the service.
13/// # Using the `Client`
14/// 
15/// A client has a function for every operation that can be performed by the service.
16/// For example, the [`AssumeRole`](crate::operation::assume_role) operation has
17/// a [`Client::assume_role`], function which returns a builder for that operation.
18/// The fluent builder ultimately has a `send()` function that returns an async future that
19/// returns a result, as illustrated below:
20/// 
21/// ```rust,ignore
22/// let result = client.assume_role()
23///     .role_arn("example")
24///     .send()
25///     .await;
26/// ```
27/// 
28/// The underlying HTTP requests that get made by this can be modified with the `customize_operation`
29/// function on the fluent builder. See the [`customize`](crate::client::customize) module for more
30/// information.
31                #[derive(::std::clone::Clone, ::std::fmt::Debug)]
32                pub struct Client {
33                    handle: ::std::sync::Arc<Handle>,
34                }
35
36                impl Client {
37                    /// Creates a new client from the service [`Config`](crate::Config).
38                    ///
39                    /// # Panics
40                    ///
41                    /// This method will panic in the following cases:
42                    ///
43                    /// - Retries or timeouts are enabled without a `sleep_impl` configured.
44                    /// - Identity caching is enabled without a `sleep_impl` and `time_source` configured.
45                    /// - No `behavior_version` is provided.
46                    ///
47                    /// The panic message for each of these will have instructions on how to resolve them.
48                    #[track_caller]
49                    pub fn from_conf(conf: crate::Config) -> Self {
50                        let handle = Handle {
51                            conf: conf.clone(),
52                            runtime_plugins: crate::config::base_client_runtime_plugins(conf),
53                        };
54                        if let Err(err) = Self::validate_config(&handle) {
55                            panic!("Invalid client configuration: {err}");
56                        }
57                        Self {
58                            handle: ::std::sync::Arc::new(handle)
59                        }
60                    }
61
62                    /// Returns the client's configuration.
63                    pub fn config(&self) -> &crate::Config {
64                        &self.handle.conf
65                    }
66
67                    fn validate_config(handle: &Handle) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
68                        let mut cfg = ::aws_smithy_types::config_bag::ConfigBag::base();
69                        handle.runtime_plugins
70                            .apply_client_configuration(&mut cfg)?
71                            .validate_base_client_config(&cfg)?;
72                        Ok(())
73                    }
74                }
75
76impl Client {
77    /// Creates a new client from an [SDK Config](::aws_types::sdk_config::SdkConfig).
78                    ///
79                    /// # Panics
80                    ///
81                    /// - This method will panic if the `sdk_config` is missing an async sleep implementation. If you experience this panic, set
82                    ///     the `sleep_impl` on the Config passed into this function to fix it.
83                    /// - This method will panic if the `sdk_config` is missing an HTTP connector. If you experience this panic, set the
84                    ///     `http_connector` on the Config passed into this function to fix it.
85                    /// - 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.
86                    #[track_caller]
87                    pub fn new(sdk_config: &::aws_types::sdk_config::SdkConfig) -> Self {
88                        Self::from_conf(sdk_config.into())
89                    }
90}
91
92mod assume_role;
93
94mod assume_role_with_saml;
95
96mod assume_role_with_web_identity;
97
98/// Operation customization and supporting types.
99/// 
100/// The underlying HTTP requests made during an operation can be customized
101/// by calling the `customize()` method on the builder returned from a client
102/// operation call. For example, this can be used to add an additional HTTP header:
103/// 
104/// ```ignore
105/// # async fn wrapper() -> ::std::result::Result<(), aws_sdk_sts::Error> {
106/// # let client: aws_sdk_sts::Client = unimplemented!();
107/// use ::http::header::{HeaderName, HeaderValue};
108/// 
109/// let result = client.assume_role()
110///     .customize()
111///     .mutate_request(|req| {
112///         // Add `x-example-header` with value
113///         req.headers_mut()
114///             .insert(
115///                 HeaderName::from_static("x-example-header"),
116///                 HeaderValue::from_static("1"),
117///             );
118///     })
119///     .send()
120///     .await;
121/// # }
122/// ```
123pub mod customize;
124
125mod decode_authorization_message;
126
127mod get_access_key_info;
128
129mod get_caller_identity;
130
131mod get_federation_token;
132
133mod get_session_token;
134