You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CognitoIdentity::Types::GetCredentialsForIdentityInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetCredentialsForIdentityInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  identity_id: "IdentityId", # required
  logins: {
    "IdentityProviderName" => "IdentityProviderToken",
  },
  custom_role_arn: "ARNString",
}

Input to the GetCredentialsForIdentity action.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#custom_role_arn ⇒ String

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.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider.

#identity_id ⇒ String

A unique identifier in the format REGION:GUID.

Returns:

  • (String) —

    A unique identifier in the format REGION:GUID.

#logins ⇒ Hash<String,String>

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.

Returns:

  • (Hash<String,String>) —

    A set of optional name-value pairs that map provider names to provider tokens.