aws_sdk_sts/operation/
assume_role.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `AssumeRole`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct AssumeRole;
6impl AssumeRole {
7    /// Creates a new `AssumeRole`
8    pub fn new() -> Self {
9        Self
10    }
11    pub(crate) async fn orchestrate(
12        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
13        input: crate::operation::assume_role::AssumeRoleInput,
14    ) -> ::std::result::Result<
15        crate::operation::assume_role::AssumeRoleOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::assume_role::AssumeRoleError,
18            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
19        >,
20    > {
21        let map_err = |err: ::aws_smithy_runtime_api::client::result::SdkError<
22            ::aws_smithy_runtime_api::client::interceptors::context::Error,
23            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
24        >| {
25            err.map_service_error(|err| {
26                err.downcast::<crate::operation::assume_role::AssumeRoleError>()
27                    .expect("correct error type")
28            })
29        };
30        let context = Self::orchestrate_with_stop_point(runtime_plugins, input, ::aws_smithy_runtime::client::orchestrator::StopPoint::None)
31            .await
32            .map_err(map_err)?;
33        let output = context.finalize().map_err(map_err)?;
34        ::std::result::Result::Ok(
35            output
36                .downcast::<crate::operation::assume_role::AssumeRoleOutput>()
37                .expect("correct output type"),
38        )
39    }
40
41    pub(crate) async fn orchestrate_with_stop_point(
42        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
43        input: crate::operation::assume_role::AssumeRoleInput,
44        stop_point: ::aws_smithy_runtime::client::orchestrator::StopPoint,
45    ) -> ::std::result::Result<
46        ::aws_smithy_runtime_api::client::interceptors::context::InterceptorContext,
47        ::aws_smithy_runtime_api::client::result::SdkError<
48            ::aws_smithy_runtime_api::client::interceptors::context::Error,
49            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
50        >,
51    > {
52        let input = ::aws_smithy_runtime_api::client::interceptors::context::Input::erase(input);
53        use ::tracing::Instrument;
54        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("STS", "AssumeRole", input, runtime_plugins, stop_point)
55            // Create a parent span for the entire operation. Includes a random, internal-only,
56            // seven-digit ID for the operation orchestration so that it can be correlated in the logs.
57            .instrument(::tracing::debug_span!(
58                "STS.AssumeRole",
59                "rpc.service" = "STS",
60                "rpc.method" = "AssumeRole",
61                "sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
62                "rpc.system" = "aws-api",
63            ))
64            .await
65    }
66
67    pub(crate) fn operation_runtime_plugins(
68        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
69        client_config: &crate::config::Config,
70        config_override: ::std::option::Option<crate::config::Builder>,
71    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
72        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
73
74        if let ::std::option::Option::Some(config_override) = config_override {
75            for plugin in config_override.runtime_plugins.iter().cloned() {
76                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
77            }
78            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
79                config_override,
80                client_config.config.clone(),
81                &client_config.runtime_components,
82            ));
83        }
84        runtime_plugins
85    }
86}
87impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for AssumeRole {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("AssumeRole");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            AssumeRoleRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            AssumeRoleResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("AssumeRole")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::SensitiveOutput);
106        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("AssumeRole", "STS"));
107        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
108        signing_options.double_uri_encode = true;
109        signing_options.content_sha256_header = false;
110        signing_options.normalize_uri_path = true;
111        signing_options.payload_override = None;
112
113        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
114            signing_options,
115            ..::std::default::Default::default()
116        });
117
118        ::std::option::Option::Some(cfg.freeze())
119    }
120
121    fn runtime_components(
122        &self,
123        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
124    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
125        #[allow(unused_mut)]
126        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("AssumeRole")
127            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
128            .with_interceptor(AssumeRoleEndpointParamsInterceptor)
129            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
130                crate::operation::assume_role::AssumeRoleError,
131            >::new())
132            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
133                crate::operation::assume_role::AssumeRoleError,
134            >::new())
135            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
136                crate::operation::assume_role::AssumeRoleError,
137            >::new());
138
139        ::std::borrow::Cow::Owned(rcb)
140    }
141}
142
143#[derive(Debug)]
144struct AssumeRoleResponseDeserializer;
145impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for AssumeRoleResponseDeserializer {
146    fn deserialize_nonstreaming(
147        &self,
148        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
149    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
150        let (success, status) = (response.status().is_success(), response.status().as_u16());
151        let headers = response.headers();
152        let body = response.body().bytes().expect("body loaded");
153        #[allow(unused_mut)]
154        let mut force_error = false;
155        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
156        let parse_result = if !success && status != 200 || force_error {
157            crate::protocol_serde::shape_assume_role::de_assume_role_http_error(status, headers, body)
158        } else {
159            crate::protocol_serde::shape_assume_role::de_assume_role_http_response(status, headers, body)
160        };
161        crate::protocol_serde::type_erase_result(parse_result)
162    }
163}
164#[derive(Debug)]
165struct AssumeRoleRequestSerializer;
166impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for AssumeRoleRequestSerializer {
167    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
168    fn serialize_input(
169        &self,
170        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
171        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
172    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
173        let input = input.downcast::<crate::operation::assume_role::AssumeRoleInput>().expect("correct type");
174        let _header_serialization_settings = _cfg
175            .load::<crate::serialization_settings::HeaderSerializationSettings>()
176            .cloned()
177            .unwrap_or_default();
178        let mut request_builder = {
179            fn uri_base(
180                _input: &crate::operation::assume_role::AssumeRoleInput,
181                output: &mut ::std::string::String,
182            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
183                use ::std::fmt::Write as _;
184                ::std::write!(output, "/").expect("formatting should succeed");
185                ::std::result::Result::Ok(())
186            }
187            #[allow(clippy::unnecessary_wraps)]
188            fn update_http_builder(
189                input: &crate::operation::assume_role::AssumeRoleInput,
190                builder: ::http::request::Builder,
191            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
192                let mut uri = ::std::string::String::new();
193                uri_base(input, &mut uri)?;
194                ::std::result::Result::Ok(builder.method("POST").uri(uri))
195            }
196            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
197            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/x-www-form-urlencoded");
198            builder
199        };
200        let body =
201            ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_assume_role_input::ser_assume_role_input_input_input(&input)?);
202        if let Some(content_length) = body.content_length() {
203            let content_length = content_length.to_string();
204            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
205        }
206        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
207    }
208}
209#[derive(Debug)]
210struct AssumeRoleEndpointParamsInterceptor;
211
212impl ::aws_smithy_runtime_api::client::interceptors::Intercept for AssumeRoleEndpointParamsInterceptor {
213    fn name(&self) -> &'static str {
214        "AssumeRoleEndpointParamsInterceptor"
215    }
216
217    fn read_before_execution(
218        &self,
219        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
220            '_,
221            ::aws_smithy_runtime_api::client::interceptors::context::Input,
222            ::aws_smithy_runtime_api::client::interceptors::context::Output,
223            ::aws_smithy_runtime_api::client::interceptors::context::Error,
224        >,
225        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
226    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
227        let _input = context
228            .input()
229            .downcast_ref::<AssumeRoleInput>()
230            .ok_or("failed to downcast to AssumeRoleInput")?;
231
232        let params = crate::config::endpoint::Params::builder()
233            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
234            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
235            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
236            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
237            .build()
238            .map_err(|err| {
239                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
240            })?;
241        cfg.interceptor_state()
242            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
243        ::std::result::Result::Ok(())
244    }
245}
246
247// The get_* functions below are generated from JMESPath expressions in the
248// operationContextParams trait. They target the operation's input shape.
249
250/// Error type for the `AssumeRoleError` operation.
251#[non_exhaustive]
252#[derive(::std::fmt::Debug)]
253pub enum AssumeRoleError {
254    /// <p>The web identity token that was passed is expired or is not valid. Get a new identity token from the identity provider and then retry the request.</p>
255    ExpiredTokenException(crate::types::error::ExpiredTokenException),
256    /// <p>The request was rejected because the policy document was malformed. The error message describes the specific error.</p>
257    MalformedPolicyDocumentException(crate::types::error::MalformedPolicyDocumentException),
258    /// <p>The request was rejected because the total packed size of the session policies and session tags combined was too large. An Amazon Web Services conversion compresses the session policy document, session policy ARNs, and session tags into a packed binary format that has a separate limit. The error message indicates by percentage how close the policies and tags are to the upper size limit. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html">Passing Session Tags in STS</a> in the <i>IAM User Guide</i>.</p>
259    /// <p>You could receive this error even though you meet other defined session policy and session tag limits. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-limits-entity-length">IAM and STS Entity Character Limits</a> in the <i>IAM User Guide</i>.</p>
260    PackedPolicyTooLargeException(crate::types::error::PackedPolicyTooLargeException),
261    /// <p>STS is not activated in the requested region for the account that is being asked to generate credentials. The account administrator must use the IAM console to activate STS in that region. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and Deactivating STS in an Amazon Web Services Region</a> in the <i>IAM User Guide</i>.</p>
262    RegionDisabledException(crate::types::error::RegionDisabledException),
263    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
264    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
265    variable wildcard pattern and check `.code()`:
266     \
267    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
268     \
269    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-AssumeRoleError) for what information is available for the error.")]
270    Unhandled(crate::error::sealed_unhandled::Unhandled),
271}
272impl AssumeRoleError {
273    /// Creates the `AssumeRoleError::Unhandled` variant from any error type.
274    pub fn unhandled(
275        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
276    ) -> Self {
277        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
278            source: err.into(),
279            meta: ::std::default::Default::default(),
280        })
281    }
282
283    /// Creates the `AssumeRoleError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
284    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
285        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
286            source: err.clone().into(),
287            meta: err,
288        })
289    }
290    ///
291    /// Returns error metadata, which includes the error code, message,
292    /// request ID, and potentially additional information.
293    ///
294    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
295        match self {
296            Self::ExpiredTokenException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
297            Self::MalformedPolicyDocumentException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
298            Self::PackedPolicyTooLargeException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
299            Self::RegionDisabledException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
300            Self::Unhandled(e) => &e.meta,
301        }
302    }
303    /// Returns `true` if the error kind is `AssumeRoleError::ExpiredTokenException`.
304    pub fn is_expired_token_exception(&self) -> bool {
305        matches!(self, Self::ExpiredTokenException(_))
306    }
307    /// Returns `true` if the error kind is `AssumeRoleError::MalformedPolicyDocumentException`.
308    pub fn is_malformed_policy_document_exception(&self) -> bool {
309        matches!(self, Self::MalformedPolicyDocumentException(_))
310    }
311    /// Returns `true` if the error kind is `AssumeRoleError::PackedPolicyTooLargeException`.
312    pub fn is_packed_policy_too_large_exception(&self) -> bool {
313        matches!(self, Self::PackedPolicyTooLargeException(_))
314    }
315    /// Returns `true` if the error kind is `AssumeRoleError::RegionDisabledException`.
316    pub fn is_region_disabled_exception(&self) -> bool {
317        matches!(self, Self::RegionDisabledException(_))
318    }
319}
320impl ::std::error::Error for AssumeRoleError {
321    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
322        match self {
323            Self::ExpiredTokenException(_inner) => ::std::option::Option::Some(_inner),
324            Self::MalformedPolicyDocumentException(_inner) => ::std::option::Option::Some(_inner),
325            Self::PackedPolicyTooLargeException(_inner) => ::std::option::Option::Some(_inner),
326            Self::RegionDisabledException(_inner) => ::std::option::Option::Some(_inner),
327            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
328        }
329    }
330}
331impl ::std::fmt::Display for AssumeRoleError {
332    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
333        match self {
334            Self::ExpiredTokenException(_inner) => _inner.fmt(f),
335            Self::MalformedPolicyDocumentException(_inner) => _inner.fmt(f),
336            Self::PackedPolicyTooLargeException(_inner) => _inner.fmt(f),
337            Self::RegionDisabledException(_inner) => _inner.fmt(f),
338            Self::Unhandled(_inner) => {
339                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
340                    write!(f, "unhandled error ({code})")
341                } else {
342                    f.write_str("unhandled error")
343                }
344            }
345        }
346    }
347}
348impl ::aws_smithy_types::retry::ProvideErrorKind for AssumeRoleError {
349    fn code(&self) -> ::std::option::Option<&str> {
350        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
351    }
352    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
353        ::std::option::Option::None
354    }
355}
356impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for AssumeRoleError {
357    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
358        match self {
359            Self::ExpiredTokenException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
360            Self::MalformedPolicyDocumentException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
361            Self::PackedPolicyTooLargeException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
362            Self::RegionDisabledException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
363            Self::Unhandled(_inner) => &_inner.meta,
364        }
365    }
366}
367impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for AssumeRoleError {
368    fn create_unhandled_error(
369        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
370        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
371    ) -> Self {
372        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
373            source,
374            meta: meta.unwrap_or_default(),
375        })
376    }
377}
378impl ::aws_types::request_id::RequestId for crate::operation::assume_role::AssumeRoleError {
379    fn request_id(&self) -> Option<&str> {
380        self.meta().request_id()
381    }
382}
383
384pub use crate::operation::assume_role::_assume_role_output::AssumeRoleOutput;
385
386pub use crate::operation::assume_role::_assume_role_input::AssumeRoleInput;
387
388mod _assume_role_input;
389
390mod _assume_role_output;
391
392/// Builders
393pub mod builders;