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            fn uri_base(
172                _input: &crate::operation::assume_role_with_saml::AssumeRoleWithSamlInput,
173                output: &mut ::std::string::String,
174            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
175                use ::std::fmt::Write as _;
176                ::std::write!(output, "/").expect("formatting should succeed");
177                ::std::result::Result::Ok(())
178            }
179            #[allow(clippy::unnecessary_wraps)]
180            fn update_http_builder(
181                input: &crate::operation::assume_role_with_saml::AssumeRoleWithSamlInput,
182                builder: ::http::request::Builder,
183            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
184                let mut uri = ::std::string::String::new();
185                uri_base(input, &mut uri)?;
186                ::std::result::Result::Ok(builder.method("POST").uri(uri))
187            }
188            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
189            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/x-www-form-urlencoded");
190            builder
191        };
192        let body = ::aws_smithy_types::body::SdkBody::from(
193            crate::protocol_serde::shape_assume_role_with_saml_input::ser_assume_role_with_saml_input_input_input(&input)?,
194        );
195        if let Some(content_length) = body.content_length() {
196            let content_length = content_length.to_string();
197            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
198        }
199        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
200    }
201}
202#[derive(Debug)]
203struct AssumeRoleWithSAMLEndpointParamsInterceptor;
204
205impl ::aws_smithy_runtime_api::client::interceptors::Intercept for AssumeRoleWithSAMLEndpointParamsInterceptor {
206    fn name(&self) -> &'static str {
207        "AssumeRoleWithSAMLEndpointParamsInterceptor"
208    }
209
210    fn read_before_execution(
211        &self,
212        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
213            '_,
214            ::aws_smithy_runtime_api::client::interceptors::context::Input,
215            ::aws_smithy_runtime_api::client::interceptors::context::Output,
216            ::aws_smithy_runtime_api::client::interceptors::context::Error,
217        >,
218        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
219    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
220        let _input = context
221            .input()
222            .downcast_ref::<AssumeRoleWithSamlInput>()
223            .ok_or("failed to downcast to AssumeRoleWithSamlInput")?;
224
225        let params = crate::config::endpoint::Params::builder()
226            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
227            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
228            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
229            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
230            .build()
231            .map_err(|err| {
232                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
233            })?;
234        cfg.interceptor_state()
235            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
236        ::std::result::Result::Ok(())
237    }
238}
239
240// The get_* functions below are generated from JMESPath expressions in the
241// operationContextParams trait. They target the operation's input shape.
242
243/// Error type for the `AssumeRoleWithSAMLError` operation.
244#[non_exhaustive]
245#[derive(::std::fmt::Debug)]
246pub enum AssumeRoleWithSAMLError {
247    /// <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>
248    ExpiredTokenException(crate::types::error::ExpiredTokenException),
249    /// <p>The identity provider (IdP) reported that authentication failed. This might be because the claim is invalid.</p>
250    /// <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>
251    IdpRejectedClaimException(crate::types::error::IdpRejectedClaimException),
252    /// <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>
253    InvalidIdentityTokenException(crate::types::error::InvalidIdentityTokenException),
254    /// <p>The request was rejected because the policy document was malformed. The error message describes the specific error.</p>
255    MalformedPolicyDocumentException(crate::types::error::MalformedPolicyDocumentException),
256    /// <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>
257    /// <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>
258    PackedPolicyTooLargeException(crate::types::error::PackedPolicyTooLargeException),
259    /// <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>
260    RegionDisabledException(crate::types::error::RegionDisabledException),
261    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
262    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
263    variable wildcard pattern and check `.code()`:
264     \
265    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
266     \
267    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-AssumeRoleWithSAMLError) for what information is available for the error.")]
268    Unhandled(crate::error::sealed_unhandled::Unhandled),
269}
270impl AssumeRoleWithSAMLError {
271    /// Creates the `AssumeRoleWithSAMLError::Unhandled` variant from any error type.
272    pub fn unhandled(
273        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
274    ) -> Self {
275        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
276            source: err.into(),
277            meta: ::std::default::Default::default(),
278        })
279    }
280
281    /// Creates the `AssumeRoleWithSAMLError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
282    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
283        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
284            source: err.clone().into(),
285            meta: err,
286        })
287    }
288    ///
289    /// Returns error metadata, which includes the error code, message,
290    /// request ID, and potentially additional information.
291    ///
292    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
293        match self {
294            Self::ExpiredTokenException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
295            Self::IdpRejectedClaimException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
296            Self::InvalidIdentityTokenException(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 `AssumeRoleWithSAMLError::ExpiredTokenException`.
304    pub fn is_expired_token_exception(&self) -> bool {
305        matches!(self, Self::ExpiredTokenException(_))
306    }
307    /// Returns `true` if the error kind is `AssumeRoleWithSAMLError::IdpRejectedClaimException`.
308    pub fn is_idp_rejected_claim_exception(&self) -> bool {
309        matches!(self, Self::IdpRejectedClaimException(_))
310    }
311    /// Returns `true` if the error kind is `AssumeRoleWithSAMLError::InvalidIdentityTokenException`.
312    pub fn is_invalid_identity_token_exception(&self) -> bool {
313        matches!(self, Self::InvalidIdentityTokenException(_))
314    }
315    /// Returns `true` if the error kind is `AssumeRoleWithSAMLError::MalformedPolicyDocumentException`.
316    pub fn is_malformed_policy_document_exception(&self) -> bool {
317        matches!(self, Self::MalformedPolicyDocumentException(_))
318    }
319    /// Returns `true` if the error kind is `AssumeRoleWithSAMLError::PackedPolicyTooLargeException`.
320    pub fn is_packed_policy_too_large_exception(&self) -> bool {
321        matches!(self, Self::PackedPolicyTooLargeException(_))
322    }
323    /// Returns `true` if the error kind is `AssumeRoleWithSAMLError::RegionDisabledException`.
324    pub fn is_region_disabled_exception(&self) -> bool {
325        matches!(self, Self::RegionDisabledException(_))
326    }
327}
328impl ::std::error::Error for AssumeRoleWithSAMLError {
329    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
330        match self {
331            Self::ExpiredTokenException(_inner) => ::std::option::Option::Some(_inner),
332            Self::IdpRejectedClaimException(_inner) => ::std::option::Option::Some(_inner),
333            Self::InvalidIdentityTokenException(_inner) => ::std::option::Option::Some(_inner),
334            Self::MalformedPolicyDocumentException(_inner) => ::std::option::Option::Some(_inner),
335            Self::PackedPolicyTooLargeException(_inner) => ::std::option::Option::Some(_inner),
336            Self::RegionDisabledException(_inner) => ::std::option::Option::Some(_inner),
337            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
338        }
339    }
340}
341impl ::std::fmt::Display for AssumeRoleWithSAMLError {
342    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
343        match self {
344            Self::ExpiredTokenException(_inner) => _inner.fmt(f),
345            Self::IdpRejectedClaimException(_inner) => _inner.fmt(f),
346            Self::InvalidIdentityTokenException(_inner) => _inner.fmt(f),
347            Self::MalformedPolicyDocumentException(_inner) => _inner.fmt(f),
348            Self::PackedPolicyTooLargeException(_inner) => _inner.fmt(f),
349            Self::RegionDisabledException(_inner) => _inner.fmt(f),
350            Self::Unhandled(_inner) => {
351                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
352                    write!(f, "unhandled error ({code})")
353                } else {
354                    f.write_str("unhandled error")
355                }
356            }
357        }
358    }
359}
360impl ::aws_smithy_types::retry::ProvideErrorKind for AssumeRoleWithSAMLError {
361    fn code(&self) -> ::std::option::Option<&str> {
362        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
363    }
364    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
365        ::std::option::Option::None
366    }
367}
368impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for AssumeRoleWithSAMLError {
369    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
370        match self {
371            Self::ExpiredTokenException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
372            Self::IdpRejectedClaimException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
373            Self::InvalidIdentityTokenException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
374            Self::MalformedPolicyDocumentException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
375            Self::PackedPolicyTooLargeException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
376            Self::RegionDisabledException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
377            Self::Unhandled(_inner) => &_inner.meta,
378        }
379    }
380}
381impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for AssumeRoleWithSAMLError {
382    fn create_unhandled_error(
383        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
384        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
385    ) -> Self {
386        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
387            source,
388            meta: meta.unwrap_or_default(),
389        })
390    }
391}
392impl ::aws_types::request_id::RequestId for crate::operation::assume_role_with_saml::AssumeRoleWithSAMLError {
393    fn request_id(&self) -> Option<&str> {
394        self.meta().request_id()
395    }
396}
397
398pub use crate::operation::assume_role_with_saml::_assume_role_with_saml_output::AssumeRoleWithSamlOutput;
399
400pub use crate::operation::assume_role_with_saml::_assume_role_with_saml_input::AssumeRoleWithSamlInput;
401
402mod _assume_role_with_saml_input;
403
404mod _assume_role_with_saml_output;
405
406/// Builders
407pub mod builders;