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

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

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

Overview

Note:

When making an API call, you may pass GetCredentialsForIdentityInput data as a hash:

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

Input to the GetCredentialsForIdentity action.

Instance Attribute Summary collapse

Instance Attribute Details

#custom_role_arnString

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)


272
273
274
275
276
277
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 272

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

#identity_idString

A unique identifier in the format REGION:GUID.

Returns:

  • (String)


272
273
274
275
276
277
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 272

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

#loginsHash<String,String>

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

Returns:

  • (Hash<String,String>)


272
273
274
275
276
277
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 272

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