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

Class: Aws::CognitoIdentity::Types::UnlinkIdentityInput

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

{
  identity_id: "IdentityId", # required
  logins: { # required
    "IdentityProviderName" => "IdentityProviderToken",
  },
  logins_to_remove: ["IdentityProviderName"], # required
}

Input to the UnlinkIdentity action.

Instance Attribute Summary collapse

Instance Attribute Details

#identity_idString

A unique identifier in the format REGION:GUID.

Returns:

  • (String)


1151
1152
1153
1154
1155
1156
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 1151

class UnlinkIdentityInput < Struct.new(
  :identity_id,
  :logins,
  :logins_to_remove)
  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>)


1151
1152
1153
1154
1155
1156
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 1151

class UnlinkIdentityInput < Struct.new(
  :identity_id,
  :logins,
  :logins_to_remove)
  include Aws::Structure
end

#logins_to_removeArray<String>

Provider names to unlink from this identity.

Returns:

  • (Array<String>)


1151
1152
1153
1154
1155
1156
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 1151

class UnlinkIdentityInput < Struct.new(
  :identity_id,
  :logins,
  :logins_to_remove)
  include Aws::Structure
end