aws_sdk_iam/operation/set_security_token_service_preferences/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::set_security_token_service_preferences::_set_security_token_service_preferences_output::SetSecurityTokenServicePreferencesOutputBuilder;
3
4pub use crate::operation::set_security_token_service_preferences::_set_security_token_service_preferences_input::SetSecurityTokenServicePreferencesInputBuilder;
5
6impl crate::operation::set_security_token_service_preferences::builders::SetSecurityTokenServicePreferencesInputBuilder {
7 /// Sends a request with this input using the given client.
8 pub async fn send_with(
9 self,
10 client: &crate::Client,
11 ) -> ::std::result::Result<
12 crate::operation::set_security_token_service_preferences::SetSecurityTokenServicePreferencesOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::set_security_token_service_preferences::SetSecurityTokenServicePreferencesError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.set_security_token_service_preferences();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `SetSecurityTokenServicePreferences`.
24///
25/// <p>Sets the specified version of the global endpoint token as the token version used for the Amazon Web Services account.</p>
26/// <p>By default, Security Token Service (STS) is available as a global service, and all STS requests go to a single endpoint at <code>https://sts.amazonaws.com</code>. Amazon Web Services recommends using Regional STS endpoints to reduce latency, build in redundancy, and increase session token availability. For information about Regional endpoints for STS, see <a href="https://docs.aws.amazon.com/general/latest/gr/sts.html">Security Token Service endpoints and quotas</a> in the <i>Amazon Web Services General Reference</i>.</p>
27/// <p>If you make an STS call to the global endpoint, the resulting session tokens might be valid in some Regions but not others. It depends on the version that is set in this operation. Version 1 tokens are valid only in Amazon Web Services Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens. For 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>
28/// <p>To view the current session token version, see the <code>GlobalEndpointTokenVersion</code> entry in the response of the <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_GetAccountSummary.html">GetAccountSummary</a> operation.</p>
29#[derive(::std::clone::Clone, ::std::fmt::Debug)]
30pub struct SetSecurityTokenServicePreferencesFluentBuilder {
31 handle: ::std::sync::Arc<crate::client::Handle>,
32 inner: crate::operation::set_security_token_service_preferences::builders::SetSecurityTokenServicePreferencesInputBuilder,
33 config_override: ::std::option::Option<crate::config::Builder>,
34}
35impl
36 crate::client::customize::internal::CustomizableSend<
37 crate::operation::set_security_token_service_preferences::SetSecurityTokenServicePreferencesOutput,
38 crate::operation::set_security_token_service_preferences::SetSecurityTokenServicePreferencesError,
39 > for SetSecurityTokenServicePreferencesFluentBuilder
40{
41 fn send(
42 self,
43 config_override: crate::config::Builder,
44 ) -> crate::client::customize::internal::BoxFuture<
45 crate::client::customize::internal::SendResult<
46 crate::operation::set_security_token_service_preferences::SetSecurityTokenServicePreferencesOutput,
47 crate::operation::set_security_token_service_preferences::SetSecurityTokenServicePreferencesError,
48 >,
49 > {
50 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
51 }
52}
53impl SetSecurityTokenServicePreferencesFluentBuilder {
54 /// Creates a new `SetSecurityTokenServicePreferencesFluentBuilder`.
55 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
56 Self {
57 handle,
58 inner: ::std::default::Default::default(),
59 config_override: ::std::option::Option::None,
60 }
61 }
62 /// Access the SetSecurityTokenServicePreferences as a reference.
63 pub fn as_input(&self) -> &crate::operation::set_security_token_service_preferences::builders::SetSecurityTokenServicePreferencesInputBuilder {
64 &self.inner
65 }
66 /// Sends the request and returns the response.
67 ///
68 /// If an error occurs, an `SdkError` will be returned with additional details that
69 /// can be matched against.
70 ///
71 /// By default, any retryable failures will be retried twice. Retry behavior
72 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
73 /// set when configuring the client.
74 pub async fn send(
75 self,
76 ) -> ::std::result::Result<
77 crate::operation::set_security_token_service_preferences::SetSecurityTokenServicePreferencesOutput,
78 ::aws_smithy_runtime_api::client::result::SdkError<
79 crate::operation::set_security_token_service_preferences::SetSecurityTokenServicePreferencesError,
80 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
81 >,
82 > {
83 let input = self
84 .inner
85 .build()
86 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
87 let runtime_plugins = crate::operation::set_security_token_service_preferences::SetSecurityTokenServicePreferences::operation_runtime_plugins(
88 self.handle.runtime_plugins.clone(),
89 &self.handle.conf,
90 self.config_override,
91 );
92 crate::operation::set_security_token_service_preferences::SetSecurityTokenServicePreferences::orchestrate(&runtime_plugins, input).await
93 }
94
95 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
96 pub fn customize(
97 self,
98 ) -> crate::client::customize::CustomizableOperation<
99 crate::operation::set_security_token_service_preferences::SetSecurityTokenServicePreferencesOutput,
100 crate::operation::set_security_token_service_preferences::SetSecurityTokenServicePreferencesError,
101 Self,
102 > {
103 crate::client::customize::CustomizableOperation::new(self)
104 }
105 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
106 self.set_config_override(::std::option::Option::Some(config_override.into()));
107 self
108 }
109
110 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
111 self.config_override = config_override;
112 self
113 }
114 /// <p>The version of the global endpoint token. Version 1 tokens are valid only in Amazon Web Services Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens.</p>
115 /// <p>For 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>
116 pub fn global_endpoint_token_version(mut self, input: crate::types::GlobalEndpointTokenVersion) -> Self {
117 self.inner = self.inner.global_endpoint_token_version(input);
118 self
119 }
120 /// <p>The version of the global endpoint token. Version 1 tokens are valid only in Amazon Web Services Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens.</p>
121 /// <p>For 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>
122 pub fn set_global_endpoint_token_version(mut self, input: ::std::option::Option<crate::types::GlobalEndpointTokenVersion>) -> Self {
123 self.inner = self.inner.set_global_endpoint_token_version(input);
124 self
125 }
126 /// <p>The version of the global endpoint token. Version 1 tokens are valid only in Amazon Web Services Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens.</p>
127 /// <p>For 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>
128 pub fn get_global_endpoint_token_version(&self) -> &::std::option::Option<crate::types::GlobalEndpointTokenVersion> {
129 self.inner.get_global_endpoint_token_version()
130 }
131}