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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cognitoidentity/types.rb

Overview

Input to the ‘GetCredentialsForIdentity` action.

See Also:

Constant Summary collapse

SENSITIVE = 
[:logins]

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) 


296
297
298
299
300
301
302
 
# File 'lib/aws-sdk-cognitoidentity/types.rb', line 296

class GetCredentialsForIdentityInput < Struct.new(
  :identity_id,
  :logins,
  :custom_role_arn)
  SENSITIVE = [:logins]
  include Aws::Structure
end

#identity_id ⇒ String

A unique identifier in the format REGION:GUID.

Returns:

  • (String) 


296
297
298
299
300
301
302
 
# File 'lib/aws-sdk-cognitoidentity/types.rb', line 296

class GetCredentialsForIdentityInput < Struct.new(
  :identity_id,
  :logins,
  :custom_role_arn)
  SENSITIVE = [:logins]
  include Aws::Structure
end

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

[1]: docs.aws.amazon.com/cognito/latest/developerguide/external-identity-providers.html

Returns:

  • (Hash<String,String>) 


296
297
298
299
300
301
302
 
# File 'lib/aws-sdk-cognitoidentity/types.rb', line 296

class GetCredentialsForIdentityInput < Struct.new(
  :identity_id,
  :logins,
  :custom_role_arn)
  SENSITIVE = [:logins]
  include Aws::Structure
end