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

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

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 GetIdInput data as a hash:

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

Input to the GetId action.

Instance Attribute Summary collapse

Instance Attribute Details

#account_idString

A standard AWS account ID (9+ digits).

Returns:

  • (String)


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

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

#identity_pool_idString

An identity pool ID in the format REGION:GUID.

Returns:

  • (String)


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

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

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

Returns:

  • (Hash<String,String>)


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

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