Class: Aws::CognitoIdentity::Types::GetIdInput

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

Overview

Note:

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

{
  account_id: "AccountId",
  identity_pool_id: "IdentityPoolId", # required
  logins: {
    "IdentityProviderName" => "IdentityProviderToken",
  },
}

Input to the GetId action.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#account_id ⇒ String

A standard AWS account ID (9+ digits).



340
341
342
343
344
345
 
# File 'lib/aws-sdk-cognitoidentity/types.rb', line 340

class GetIdInput < Struct.new(
  :account_id,
  :identity_pool_id,
  :logins)
  include Aws::Structure
end

#identity_pool_id ⇒ String

An identity pool ID in the format REGION:GUID.



340
341
342
343
344
345
 
# File 'lib/aws-sdk-cognitoidentity/types.rb', line 340

class GetIdInput < Struct.new(
  :account_id,
  :identity_pool_id,
  :logins)
  include Aws::Structure
end

#logins ⇒ Hash<String,String>

A set of optional name-value pairs that map provider names to provider tokens. The available provider names for ‘Logins` are as follows:

  • Facebook: ‘graph.facebook.com`

  • Amazon Cognito Identity Provider: ‘cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789`

  • Google: ‘accounts.google.com`

  • Amazon: ‘www.amazon.com`

  • Twitter: ‘api.twitter.com`

  • Digits: ‘www.digits.com`



340
341
342
343
344
345
 
# File 'lib/aws-sdk-cognitoidentity/types.rb', line 340

class GetIdInput < Struct.new(
  :account_id,
  :identity_pool_id,
  :logins)
  include Aws::Structure
end