aws_sdk_ssooidc/operation/create_token/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_token::_create_token_output::CreateTokenOutputBuilder;
3
4pub use crate::operation::create_token::_create_token_input::CreateTokenInputBuilder;
5
6impl crate::operation::create_token::builders::CreateTokenInputBuilder {
7 /// Sends a request with this input using the given client.
8 pub async fn send_with(self, client: &crate::Client) -> ::std::result::Result<
9 crate::operation::create_token::CreateTokenOutput,
10 ::aws_smithy_runtime_api::client::result::SdkError<
11 crate::operation::create_token::CreateTokenError,
12 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse
13 >
14 > {
15 let mut fluent_builder = client.create_token();
16 fluent_builder.inner = self;
17 fluent_builder.send().await
18 }
19 }
20/// Fluent builder constructing a request to `CreateToken`.
21///
22/// <p>Creates and returns access and refresh tokens for clients that are authenticated using client secrets. The access token can be used to fetch short-lived credentials for the assigned AWS accounts or to access application APIs using <code>bearer</code> authentication.</p>
23#[derive(::std::clone::Clone, ::std::fmt::Debug)]
24pub struct CreateTokenFluentBuilder {
25 handle: ::std::sync::Arc<crate::client::Handle>,
26 inner: crate::operation::create_token::builders::CreateTokenInputBuilder,
27config_override: ::std::option::Option<crate::config::Builder>,
28 }
29impl
30 crate::client::customize::internal::CustomizableSend<
31 crate::operation::create_token::CreateTokenOutput,
32 crate::operation::create_token::CreateTokenError,
33 > for CreateTokenFluentBuilder
34 {
35 fn send(
36 self,
37 config_override: crate::config::Builder,
38 ) -> crate::client::customize::internal::BoxFuture<
39 crate::client::customize::internal::SendResult<
40 crate::operation::create_token::CreateTokenOutput,
41 crate::operation::create_token::CreateTokenError,
42 >,
43 > {
44 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
45 }
46 }
47impl CreateTokenFluentBuilder {
48 /// Creates a new `CreateTokenFluentBuilder`.
49 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
50 Self {
51 handle,
52 inner: ::std::default::Default::default(),
53 config_override: ::std::option::Option::None,
54 }
55 }
56 /// Access the CreateToken as a reference.
57 pub fn as_input(&self) -> &crate::operation::create_token::builders::CreateTokenInputBuilder {
58 &self.inner
59 }
60 /// Sends the request and returns the response.
61 ///
62 /// If an error occurs, an `SdkError` will be returned with additional details that
63 /// can be matched against.
64 ///
65 /// By default, any retryable failures will be retried twice. Retry behavior
66 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
67 /// set when configuring the client. Note: retries are enabled by default when using
68 /// `aws_config::load_from_env()` or when using `BehaviorVersion::v2025_01_17()` or later.
69 pub async fn send(self) -> ::std::result::Result<crate::operation::create_token::CreateTokenOutput, ::aws_smithy_runtime_api::client::result::SdkError<crate::operation::create_token::CreateTokenError, ::aws_smithy_runtime_api::client::orchestrator::HttpResponse>> {
70 let input = self.inner.build().map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
71 let runtime_plugins = crate::operation::create_token::CreateToken::operation_runtime_plugins(
72 self.handle.runtime_plugins.clone(),
73 &self.handle.conf,
74 self.config_override,
75 );
76 crate::operation::create_token::CreateToken::orchestrate(&runtime_plugins, input).await
77 }
78
79 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
80 pub fn customize(
81 self,
82 ) -> crate::client::customize::CustomizableOperation<crate::operation::create_token::CreateTokenOutput, crate::operation::create_token::CreateTokenError, Self> {
83 crate::client::customize::CustomizableOperation::new(self)
84 }
85 pub(crate) fn config_override(
86 mut self,
87 config_override: impl ::std::convert::Into<crate::config::Builder>,
88 ) -> Self {
89 self.set_config_override(::std::option::Option::Some(config_override.into()));
90 self
91 }
92
93 pub(crate) fn set_config_override(
94 &mut self,
95 config_override: ::std::option::Option<crate::config::Builder>,
96 ) -> &mut Self {
97 self.config_override = config_override;
98 self
99 }
100 /// <p>The unique identifier string for the client or application. This value comes from the result of the <code>RegisterClient</code> API.</p>
101 pub fn client_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
102 self.inner = self.inner.client_id(input.into());
103 self
104 }
105 /// <p>The unique identifier string for the client or application. This value comes from the result of the <code>RegisterClient</code> API.</p>
106 pub fn set_client_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
107 self.inner = self.inner.set_client_id(input);
108 self
109 }
110 /// <p>The unique identifier string for the client or application. This value comes from the result of the <code>RegisterClient</code> API.</p>
111 pub fn get_client_id(&self) -> &::std::option::Option<::std::string::String> {
112 self.inner.get_client_id()
113 }
114 /// <p>A secret string generated for the client. This value should come from the persisted result of the <code>RegisterClient</code> API.</p>
115 pub fn client_secret(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
116 self.inner = self.inner.client_secret(input.into());
117 self
118 }
119 /// <p>A secret string generated for the client. This value should come from the persisted result of the <code>RegisterClient</code> API.</p>
120 pub fn set_client_secret(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
121 self.inner = self.inner.set_client_secret(input);
122 self
123 }
124 /// <p>A secret string generated for the client. This value should come from the persisted result of the <code>RegisterClient</code> API.</p>
125 pub fn get_client_secret(&self) -> &::std::option::Option<::std::string::String> {
126 self.inner.get_client_secret()
127 }
128 /// <p>Supports the following OAuth grant types: Authorization Code, Device Code, and Refresh Token. Specify one of the following values, depending on the grant type that you want:</p>
129 /// <p>* Authorization Code - <code>authorization_code</code></p>
130 /// <p>* Device Code - <code>urn:ietf:params:oauth:grant-type:device_code</code></p>
131 /// <p>* Refresh Token - <code>refresh_token</code></p>
132 pub fn grant_type(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
133 self.inner = self.inner.grant_type(input.into());
134 self
135 }
136 /// <p>Supports the following OAuth grant types: Authorization Code, Device Code, and Refresh Token. Specify one of the following values, depending on the grant type that you want:</p>
137 /// <p>* Authorization Code - <code>authorization_code</code></p>
138 /// <p>* Device Code - <code>urn:ietf:params:oauth:grant-type:device_code</code></p>
139 /// <p>* Refresh Token - <code>refresh_token</code></p>
140 pub fn set_grant_type(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
141 self.inner = self.inner.set_grant_type(input);
142 self
143 }
144 /// <p>Supports the following OAuth grant types: Authorization Code, Device Code, and Refresh Token. Specify one of the following values, depending on the grant type that you want:</p>
145 /// <p>* Authorization Code - <code>authorization_code</code></p>
146 /// <p>* Device Code - <code>urn:ietf:params:oauth:grant-type:device_code</code></p>
147 /// <p>* Refresh Token - <code>refresh_token</code></p>
148 pub fn get_grant_type(&self) -> &::std::option::Option<::std::string::String> {
149 self.inner.get_grant_type()
150 }
151 /// <p>Used only when calling this API for the Device Code grant type. This short-lived code is used to identify this authorization request. This comes from the result of the <code>StartDeviceAuthorization</code> API.</p>
152 pub fn device_code(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
153 self.inner = self.inner.device_code(input.into());
154 self
155 }
156 /// <p>Used only when calling this API for the Device Code grant type. This short-lived code is used to identify this authorization request. This comes from the result of the <code>StartDeviceAuthorization</code> API.</p>
157 pub fn set_device_code(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
158 self.inner = self.inner.set_device_code(input);
159 self
160 }
161 /// <p>Used only when calling this API for the Device Code grant type. This short-lived code is used to identify this authorization request. This comes from the result of the <code>StartDeviceAuthorization</code> API.</p>
162 pub fn get_device_code(&self) -> &::std::option::Option<::std::string::String> {
163 self.inner.get_device_code()
164 }
165 /// <p>Used only when calling this API for the Authorization Code grant type. The short-lived code is used to identify this authorization request.</p>
166 pub fn code(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
167 self.inner = self.inner.code(input.into());
168 self
169 }
170 /// <p>Used only when calling this API for the Authorization Code grant type. The short-lived code is used to identify this authorization request.</p>
171 pub fn set_code(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
172 self.inner = self.inner.set_code(input);
173 self
174 }
175 /// <p>Used only when calling this API for the Authorization Code grant type. The short-lived code is used to identify this authorization request.</p>
176 pub fn get_code(&self) -> &::std::option::Option<::std::string::String> {
177 self.inner.get_code()
178 }
179 /// <p>Used only when calling this API for the Refresh Token grant type. This token is used to refresh short-lived tokens, such as the access token, that might expire.</p>
180 /// <p>For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see <i>Considerations for Using this Guide</i> in the <a href="https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html">IAM Identity Center OIDC API Reference</a>.</p>
181 pub fn refresh_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
182 self.inner = self.inner.refresh_token(input.into());
183 self
184 }
185 /// <p>Used only when calling this API for the Refresh Token grant type. This token is used to refresh short-lived tokens, such as the access token, that might expire.</p>
186 /// <p>For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see <i>Considerations for Using this Guide</i> in the <a href="https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html">IAM Identity Center OIDC API Reference</a>.</p>
187 pub fn set_refresh_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
188 self.inner = self.inner.set_refresh_token(input);
189 self
190 }
191 /// <p>Used only when calling this API for the Refresh Token grant type. This token is used to refresh short-lived tokens, such as the access token, that might expire.</p>
192 /// <p>For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see <i>Considerations for Using this Guide</i> in the <a href="https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html">IAM Identity Center OIDC API Reference</a>.</p>
193 pub fn get_refresh_token(&self) -> &::std::option::Option<::std::string::String> {
194 self.inner.get_refresh_token()
195 }
196 ///
197 /// Appends an item to `scope`.
198 ///
199 /// To override the contents of this collection use [`set_scope`](Self::set_scope).
200 ///
201 /// <p>The list of scopes for which authorization is requested. This parameter has no effect; the access token will always include all scopes configured during client registration.</p>
202 pub fn scope(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
203 self.inner = self.inner.scope(input.into());
204 self
205 }
206 /// <p>The list of scopes for which authorization is requested. This parameter has no effect; the access token will always include all scopes configured during client registration.</p>
207 pub fn set_scope(mut self, input: ::std::option::Option<::std::vec::Vec::<::std::string::String>>) -> Self {
208 self.inner = self.inner.set_scope(input);
209 self
210 }
211 /// <p>The list of scopes for which authorization is requested. This parameter has no effect; the access token will always include all scopes configured during client registration.</p>
212 pub fn get_scope(&self) -> &::std::option::Option<::std::vec::Vec::<::std::string::String>> {
213 self.inner.get_scope()
214 }
215 /// <p>Used only when calling this API for the Authorization Code grant type. This value specifies the location of the client or application that has registered to receive the authorization code.</p>
216 pub fn redirect_uri(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
217 self.inner = self.inner.redirect_uri(input.into());
218 self
219 }
220 /// <p>Used only when calling this API for the Authorization Code grant type. This value specifies the location of the client or application that has registered to receive the authorization code.</p>
221 pub fn set_redirect_uri(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
222 self.inner = self.inner.set_redirect_uri(input);
223 self
224 }
225 /// <p>Used only when calling this API for the Authorization Code grant type. This value specifies the location of the client or application that has registered to receive the authorization code.</p>
226 pub fn get_redirect_uri(&self) -> &::std::option::Option<::std::string::String> {
227 self.inner.get_redirect_uri()
228 }
229 /// <p>Used only when calling this API for the Authorization Code grant type. This value is generated by the client and presented to validate the original code challenge value the client passed at authorization time.</p>
230 pub fn code_verifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
231 self.inner = self.inner.code_verifier(input.into());
232 self
233 }
234 /// <p>Used only when calling this API for the Authorization Code grant type. This value is generated by the client and presented to validate the original code challenge value the client passed at authorization time.</p>
235 pub fn set_code_verifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
236 self.inner = self.inner.set_code_verifier(input);
237 self
238 }
239 /// <p>Used only when calling this API for the Authorization Code grant type. This value is generated by the client and presented to validate the original code challenge value the client passed at authorization time.</p>
240 pub fn get_code_verifier(&self) -> &::std::option::Option<::std::string::String> {
241 self.inner.get_code_verifier()
242 }
243}
244