aws_sdk_cognitoidentity/operation/get_credentials_for_identity/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::get_credentials_for_identity::_get_credentials_for_identity_output::GetCredentialsForIdentityOutputBuilder;
3
4pub use crate::operation::get_credentials_for_identity::_get_credentials_for_identity_input::GetCredentialsForIdentityInputBuilder;
5
6impl crate::operation::get_credentials_for_identity::builders::GetCredentialsForIdentityInputBuilder {
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::get_credentials_for_identity::GetCredentialsForIdentityOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::get_credentials_for_identity::GetCredentialsForIdentityError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.get_credentials_for_identity();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `GetCredentialsForIdentity`.
24///
25/// <p>Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for <code>cognito-identity.amazonaws.com</code>, it will be passed through to Security Token Service with the appropriate role for the token.</p>
26/// <p>This is a public API. You do not need any credentials to call this API.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct GetCredentialsForIdentityFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::get_credentials_for_identity::builders::GetCredentialsForIdentityInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::get_credentials_for_identity::GetCredentialsForIdentityOutput,
36        crate::operation::get_credentials_for_identity::GetCredentialsForIdentityError,
37    > for GetCredentialsForIdentityFluentBuilder
38{
39    fn send(
40        self,
41        config_override: crate::config::Builder,
42    ) -> crate::client::customize::internal::BoxFuture<
43        crate::client::customize::internal::SendResult<
44            crate::operation::get_credentials_for_identity::GetCredentialsForIdentityOutput,
45            crate::operation::get_credentials_for_identity::GetCredentialsForIdentityError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl GetCredentialsForIdentityFluentBuilder {
52    /// Creates a new `GetCredentialsForIdentityFluentBuilder`.
53    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
54        Self {
55            handle,
56            inner: ::std::default::Default::default(),
57            config_override: ::std::option::Option::None,
58        }
59    }
60    /// Access the GetCredentialsForIdentity as a reference.
61    pub fn as_input(&self) -> &crate::operation::get_credentials_for_identity::builders::GetCredentialsForIdentityInputBuilder {
62        &self.inner
63    }
64    /// Sends the request and returns the response.
65    ///
66    /// If an error occurs, an `SdkError` will be returned with additional details that
67    /// can be matched against.
68    ///
69    /// By default, any retryable failures will be retried twice. Retry behavior
70    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
71    /// set when configuring the client.
72    pub async fn send(
73        self,
74    ) -> ::std::result::Result<
75        crate::operation::get_credentials_for_identity::GetCredentialsForIdentityOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::get_credentials_for_identity::GetCredentialsForIdentityError,
78            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
79        >,
80    > {
81        let input = self
82            .inner
83            .build()
84            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
85        let runtime_plugins = crate::operation::get_credentials_for_identity::GetCredentialsForIdentity::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::get_credentials_for_identity::GetCredentialsForIdentity::orchestrate(&runtime_plugins, input).await
91    }
92
93    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
94    pub fn customize(
95        self,
96    ) -> crate::client::customize::CustomizableOperation<
97        crate::operation::get_credentials_for_identity::GetCredentialsForIdentityOutput,
98        crate::operation::get_credentials_for_identity::GetCredentialsForIdentityError,
99        Self,
100    > {
101        crate::client::customize::CustomizableOperation::new(self)
102    }
103    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
104        self.set_config_override(::std::option::Option::Some(config_override.into()));
105        self
106    }
107
108    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
109        self.config_override = config_override;
110        self
111    }
112    /// <p>A unique identifier in the format REGION:GUID.</p>
113    pub fn identity_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
114        self.inner = self.inner.identity_id(input.into());
115        self
116    }
117    /// <p>A unique identifier in the format REGION:GUID.</p>
118    pub fn set_identity_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
119        self.inner = self.inner.set_identity_id(input);
120        self
121    }
122    /// <p>A unique identifier in the format REGION:GUID.</p>
123    pub fn get_identity_id(&self) -> &::std::option::Option<::std::string::String> {
124        self.inner.get_identity_id()
125    }
126    ///
127    /// Adds a key-value pair to `Logins`.
128    ///
129    /// To override the contents of this collection use [`set_logins`](Self::set_logins).
130    ///
131    /// <p>A set of optional name-value pairs that map provider names to provider tokens. The name-value pair will follow the syntax "provider_name": "provider_user_identifier".</p>
132    /// <p>Logins should not be specified when trying to get credentials for an unauthenticated identity.</p>
133    /// <p>The Logins parameter is required when using identities associated with external identity providers such as Facebook. For examples of <code>Logins</code> maps, see the code examples in the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/external-identity-providers.html">External Identity Providers</a> section of the Amazon Cognito Developer Guide.</p>
134    pub fn logins(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
135        self.inner = self.inner.logins(k.into(), v.into());
136        self
137    }
138    /// <p>A set of optional name-value pairs that map provider names to provider tokens. The name-value pair will follow the syntax "provider_name": "provider_user_identifier".</p>
139    /// <p>Logins should not be specified when trying to get credentials for an unauthenticated identity.</p>
140    /// <p>The Logins parameter is required when using identities associated with external identity providers such as Facebook. For examples of <code>Logins</code> maps, see the code examples in the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/external-identity-providers.html">External Identity Providers</a> section of the Amazon Cognito Developer Guide.</p>
141    pub fn set_logins(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
142        self.inner = self.inner.set_logins(input);
143        self
144    }
145    /// <p>A set of optional name-value pairs that map provider names to provider tokens. The name-value pair will follow the syntax "provider_name": "provider_user_identifier".</p>
146    /// <p>Logins should not be specified when trying to get credentials for an unauthenticated identity.</p>
147    /// <p>The Logins parameter is required when using identities associated with external identity providers such as Facebook. For examples of <code>Logins</code> maps, see the code examples in the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/external-identity-providers.html">External Identity Providers</a> section of the Amazon Cognito Developer Guide.</p>
148    pub fn get_logins(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
149        self.inner.get_logins()
150    }
151    /// <p>The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider. For example, a SAML-based identity provider. This parameter is optional for identity providers that do not support role customization.</p>
152    pub fn custom_role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
153        self.inner = self.inner.custom_role_arn(input.into());
154        self
155    }
156    /// <p>The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider. For example, a SAML-based identity provider. This parameter is optional for identity providers that do not support role customization.</p>
157    pub fn set_custom_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
158        self.inner = self.inner.set_custom_role_arn(input);
159        self
160    }
161    /// <p>The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider. For example, a SAML-based identity provider. This parameter is optional for identity providers that do not support role customization.</p>
162    pub fn get_custom_role_arn(&self) -> &::std::option::Option<::std::string::String> {
163        self.inner.get_custom_role_arn()
164    }
165}
aws_sdk_cognitoidentity/operation/get_credentials_for_identity/builders.rs

aws_sdk_cognitoidentity/operation/get_credentials_for_identity/
builders.rs
