aws_sdk_sts/operation/
assume_role_with_saml.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `AssumeRoleWithSAML`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct AssumeRoleWithSAML;
6impl AssumeRoleWithSAML {
7    /// Creates a new `AssumeRoleWithSAML`
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_with_saml::AssumeRoleWithSamlInput,
14    ) -> ::std::result::Result<
15        crate::operation::assume_role_with_saml::AssumeRoleWithSamlOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::assume_role_with_saml::AssumeRoleWithSAMLError,
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_with_saml::AssumeRoleWithSAMLError>()
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_with_saml::AssumeRoleWithSamlOutput>()
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_with_saml::AssumeRoleWithSamlInput,
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", "AssumeRoleWithSAML", 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.AssumeRoleWithSAML",
59                "rpc.service" = "STS",
60                "rpc.method" = "AssumeRoleWithSAML",
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 AssumeRoleWithSAML {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("AssumeRoleWithSAML");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            AssumeRoleWithSAMLRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            AssumeRoleWithSAMLResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("AssumeRoleWithSAML")
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("AssumeRoleWithSAML", "STS"));
107
108        ::std::option::Option::Some(cfg.freeze())
109    }
110
111    fn runtime_components(
112        &self,
113        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
114    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
115        #[allow(unused_mut)]
116        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("AssumeRoleWithSAML")
117            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
118            .with_interceptor(AssumeRoleWithSAMLEndpointParamsInterceptor)
119            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
120                crate::operation::assume_role_with_saml::AssumeRoleWithSAMLError,
121            >::new())
122            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
123                crate::operation::assume_role_with_saml::AssumeRoleWithSAMLError,
124            >::new())
125            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
126                crate::operation::assume_role_with_saml::AssumeRoleWithSAMLError,
127            >::new());
128
129        ::std::borrow::Cow::Owned(rcb)
130    }
131}
132
133#[derive(Debug)]
134struct AssumeRoleWithSAMLResponseDeserializer;
135impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for AssumeRoleWithSAMLResponseDeserializer {
136    fn deserialize_nonstreaming(
137        &self,
138        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
139    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
140        let (success, status) = (response.status().is_success(), response.status().as_u16());
141        let headers = response.headers();
142        let body = response.body().bytes().expect("body loaded");
143        #[allow(unused_mut)]
144        let mut force_error = false;
145        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
146        let parse_result = if !success && status != 200 || force_error {
147            crate::protocol_serde::shape_assume_role_with_saml::de_assume_role_with_saml_http_error(status, headers, body)
148        } else {
149            crate::protocol_serde::shape_assume_role_with_saml::de_assume_role_with_saml_http_response(status, headers, body)
150        };
151        crate::protocol_serde::type_erase_result(parse_result)
152    }
153}
154#[derive(Debug)]
155struct AssumeRoleWithSAMLRequestSerializer;
156impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for AssumeRoleWithSAMLRequestSerializer {
157    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
158    fn serialize_input(
159        &self,
160        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
161        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
162    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
163        let input = input
164            .downcast::<crate::operation::assume_role_with_saml::AssumeRoleWithSamlInput>()
165            .expect("correct type");
166        let _header_serialization_settings = _cfg
167            .load::<crate::serialization_settings::HeaderSerializationSettings>()
168            .cloned()
169            .unwrap_or_default();
170        let mut request_builder = {
171            #[allow(clippy::uninlined_format_args)]
172            fn uri_base(
173                _input: &crate::operation::assume_role_with_saml::AssumeRoleWithSamlInput,
174                output: &mut ::std::string::String,
175            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
176                use ::std::fmt::Write as _;
177                ::std::write!(output, "/").expect("formatting should succeed");
178                ::std::result::Result::Ok(())
179            }
180            #[allow(clippy::unnecessary_wraps)]
181            fn update_http_builder(
182                input: &crate::operation::assume_role_with_saml::AssumeRoleWithSamlInput,
183                builder: ::http::request::Builder,
184            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
185                let mut uri = ::std::string::String::new();
186                uri_base(input, &mut uri)?;
187                ::std::result::Result::Ok(builder.method("POST").uri(uri))
188            }
189            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
190            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/x-www-form-urlencoded");
191            builder
192        };
193        let body = ::aws_smithy_types::body::SdkBody::from(
194            crate::protocol_serde::shape_assume_role_with_saml_input::ser_assume_role_with_saml_input_input_input(&input)?,
195        );
196        if let Some(content_length) = body.content_length() {
197            let content_length = content_length.to_string();
198            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
199        }
200        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
201    }
202}
203#[derive(Debug)]
204struct AssumeRoleWithSAMLEndpointParamsInterceptor;
205
206impl ::aws_smithy_runtime_api::client::interceptors::Intercept for AssumeRoleWithSAMLEndpointParamsInterceptor {
207    fn name(&self) -> &'static str {
208        "AssumeRoleWithSAMLEndpointParamsInterceptor"
209    }
210
211    fn read_before_execution(
212        &self,
213        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
214            '_,
215            ::aws_smithy_runtime_api::client::interceptors::context::Input,
216            ::aws_smithy_runtime_api::client::interceptors::context::Output,
217            ::aws_smithy_runtime_api::client::interceptors::context::Error,
218        >,
219        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
220    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
221        let _input = context
222            .input()
223            .downcast_ref::<AssumeRoleWithSamlInput>()
224            .ok_or("failed to downcast to AssumeRoleWithSamlInput")?;
225
226        let params = crate::config::endpoint::Params::builder()
227            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
228            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
229            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
230            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
231            .build()
232            .map_err(|err| {
233                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
234            })?;
235        cfg.interceptor_state()
236            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
237        ::std::result::Result::Ok(())
238    }
239}
240
241// The get_* functions below are generated from JMESPath expressions in the
242// operationContextParams trait. They target the operation's input shape.
243
244/// Error type for the `AssumeRoleWithSAMLError` operation.
245#[non_exhaustive]
246#[derive(::std::fmt::Debug)]
247pub enum AssumeRoleWithSAMLError {
248    /// <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>
249    ExpiredTokenException(crate::types::error::ExpiredTokenException),
250    /// <p>The identity provider (IdP) reported that authentication failed. This might be because the claim is invalid.</p>
251    /// <p>If this error is returned for the <code>AssumeRoleWithWebIdentity</code> operation, it can also mean that the claim has expired or has been explicitly revoked.</p>
252    IdpRejectedClaimException(crate::types::error::IdpRejectedClaimException),
253    /// <p>The web identity token that was passed could not be validated by Amazon Web Services. Get a new identity token from the identity provider and then retry the request.</p>
254    InvalidIdentityTokenException(crate::types::error::InvalidIdentityTokenException),
255    /// <p>The request was rejected because the policy document was malformed. The error message describes the specific error.</p>
256    MalformedPolicyDocumentException(crate::types::error::MalformedPolicyDocumentException),
257    /// <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>
258    /// <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>
259    PackedPolicyTooLargeException(crate::types::error::PackedPolicyTooLargeException),
260    /// <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#sts-regions-activate-deactivate">Activating and Deactivating STS in an Amazon Web Services Region</a> in the <i>IAM User Guide</i>.</p>
261    RegionDisabledException(crate::types::error::RegionDisabledException),
262    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
263    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
264    variable wildcard pattern and check `.code()`:
265     \
266    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
267     \
268    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-AssumeRoleWithSAMLError) for what information is available for the error.")]
269    Unhandled(crate::error::sealed_unhandled::Unhandled),
270}
271impl AssumeRoleWithSAMLError {
272    /// Creates the `AssumeRoleWithSAMLError::Unhandled` variant from any error type.
273    pub fn unhandled(
274        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
275    ) -> Self {
276        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
277            source: err.into(),
278            meta: ::std::default::Default::default(),
279        })
280    }
281
282    /// Creates the `AssumeRoleWithSAMLError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
283    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
284        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
285            source: err.clone().into(),
286            meta: err,
287        })
288    }
289    ///
290    /// Returns error metadata, which includes the error code, message,
291    /// request ID, and potentially additional information.
292    ///
293    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
294        match self {
295            Self::ExpiredTokenException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
296            Self::IdpRejectedClaimException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
297            Self::InvalidIdentityTokenException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
298            Self::MalformedPolicyDocumentException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
299            Self::PackedPolicyTooLargeException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
300            Self::RegionDisabledException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
301            Self::Unhandled(e) => &e.meta,
302        }
303    }
304    /// Returns `true` if the error kind is `AssumeRoleWithSAMLError::ExpiredTokenException`.
305    pub fn is_expired_token_exception(&self) -> bool {
306        matches!(self, Self::ExpiredTokenException(_))
307    }
308    /// Returns `true` if the error kind is `AssumeRoleWithSAMLError::IdpRejectedClaimException`.
309    pub fn is_idp_rejected_claim_exception(&self) -> bool {
310        matches!(self, Self::IdpRejectedClaimException(_))
311    }
312    /// Returns `true` if the error kind is `AssumeRoleWithSAMLError::InvalidIdentityTokenException`.
313    pub fn is_invalid_identity_token_exception(&self) -> bool {
314        matches!(self, Self::InvalidIdentityTokenException(_))
315    }
316    /// Returns `true` if the error kind is `AssumeRoleWithSAMLError::MalformedPolicyDocumentException`.
317    pub fn is_malformed_policy_document_exception(&self) -> bool {
318        matches!(self, Self::MalformedPolicyDocumentException(_))
319    }
320    /// Returns `true` if the error kind is `AssumeRoleWithSAMLError::PackedPolicyTooLargeException`.
321    pub fn is_packed_policy_too_large_exception(&self) -> bool {
322        matches!(self, Self::PackedPolicyTooLargeException(_))
323    }
324    /// Returns `true` if the error kind is `AssumeRoleWithSAMLError::RegionDisabledException`.
325    pub fn is_region_disabled_exception(&self) -> bool {
326        matches!(self, Self::RegionDisabledException(_))
327    }
328}
329impl ::std::error::Error for AssumeRoleWithSAMLError {
330    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
331        match self {
332            Self::ExpiredTokenException(_inner) => ::std::option::Option::Some(_inner),
333            Self::IdpRejectedClaimException(_inner) => ::std::option::Option::Some(_inner),
334            Self::InvalidIdentityTokenException(_inner) => ::std::option::Option::Some(_inner),
335            Self::MalformedPolicyDocumentException(_inner) => ::std::option::Option::Some(_inner),
336            Self::PackedPolicyTooLargeException(_inner) => ::std::option::Option::Some(_inner),
337            Self::RegionDisabledException(_inner) => ::std::option::Option::Some(_inner),
338            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
339        }
340    }
341}
342impl ::std::fmt::Display for AssumeRoleWithSAMLError {
343    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
344        match self {
345            Self::ExpiredTokenException(_inner) => _inner.fmt(f),
346            Self::IdpRejectedClaimException(_inner) => _inner.fmt(f),
347            Self::InvalidIdentityTokenException(_inner) => _inner.fmt(f),
348            Self::MalformedPolicyDocumentException(_inner) => _inner.fmt(f),
349            Self::PackedPolicyTooLargeException(_inner) => _inner.fmt(f),
350            Self::RegionDisabledException(_inner) => _inner.fmt(f),
351            Self::Unhandled(_inner) => {
352                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
353                    write!(f, "unhandled error ({code})")
354                } else {
355                    f.write_str("unhandled error")
356                }
357            }
358        }
359    }
360}
361impl ::aws_smithy_types::retry::ProvideErrorKind for AssumeRoleWithSAMLError {
362    fn code(&self) -> ::std::option::Option<&str> {
363        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
364    }
365    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
366        ::std::option::Option::None
367    }
368}
369impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for AssumeRoleWithSAMLError {
370    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
371        match self {
372            Self::ExpiredTokenException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
373            Self::IdpRejectedClaimException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
374            Self::InvalidIdentityTokenException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
375            Self::MalformedPolicyDocumentException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
376            Self::PackedPolicyTooLargeException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
377            Self::RegionDisabledException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
378            Self::Unhandled(_inner) => &_inner.meta,
379        }
380    }
381}
382impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for AssumeRoleWithSAMLError {
383    fn create_unhandled_error(
384        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
385        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
386    ) -> Self {
387        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
388            source,
389            meta: meta.unwrap_or_default(),
390        })
391    }
392}
393impl ::aws_types::request_id::RequestId for crate::operation::assume_role_with_saml::AssumeRoleWithSAMLError {
394    fn request_id(&self) -> Option<&str> {
395        self.meta().request_id()
396    }
397}
398
399pub use crate::operation::assume_role_with_saml::_assume_role_with_saml_output::AssumeRoleWithSamlOutput;
400
401pub use crate::operation::assume_role_with_saml::_assume_role_with_saml_input::AssumeRoleWithSamlInput;
402
403mod _assume_role_with_saml_input;
404
405mod _assume_role_with_saml_output;
406
407/// Builders
408pub mod builders;