Struct aws_sdk_cognitoidentity::client::fluent_builders::GetCredentialsForIdentity

pub struct GetCredentialsForIdentity { /* private fields */ }

Fluent builder constructing a request to GetCredentialsForIdentity.

Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token.

This is a public API. You do not need any credentials to call this API.

Implementations

impl GetCredentialsForIdentity

pub async fn send(
    self
) -> Result<GetCredentialsForIdentityOutput, SdkError<GetCredentialsForIdentityError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn identity_id(self, input: impl Into<String>) -> Self

A unique identifier in the format REGION:GUID.

pub fn set_identity_id(self, input: Option<String>) -> Self

A unique identifier in the format REGION:GUID.

pub fn logins(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to Logins.

To override the contents of this collection use set_logins.

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".

Logins should not be specified when trying to get credentials for an unauthenticated identity.

The Logins parameter is required when using identities associated with external identity providers such as Facebook. For examples of Logins maps, see the code examples in the External Identity Providers section of the Amazon Cognito Developer Guide.

pub fn set_logins(self, input: Option<HashMap<String, String>>) -> Self

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".

Logins should not be specified when trying to get credentials for an unauthenticated identity.

The Logins parameter is required when using identities associated with external identity providers such as Facebook. For examples of Logins maps, see the code examples in the External Identity Providers section of the Amazon Cognito Developer Guide.

pub fn custom_role_arn(self, input: impl Into<String>) -> Self

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.

pub fn set_custom_role_arn(self, input: Option<String>) -> Self

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.

Trait Implementations

impl Clone for GetCredentialsForIdentity

fn clone(&self) -> GetCredentialsForIdentity

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetCredentialsForIdentity

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.