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

Class: Aws::CognitoIdentity::Types::LookupDeveloperIdentityInput

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

{
  identity_pool_id: "IdentityPoolId", # required
  identity_id: "IdentityId",
  developer_user_identifier: "DeveloperUserIdentifier",
  max_results: 1,
  next_token: "PaginationKey",
}

Input to the LookupDeveloperIdentityInput action.

Instance Attribute Summary collapse

Instance Attribute Details

#developer_user_identifierString

A unique ID used by your backend authentication process to identify a user. Typically, a developer identity provider would issue many developer user identifiers, in keeping with the number of users.

Returns:

  • (String)


803
804
805
806
807
808
809
810
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 803

class LookupDeveloperIdentityInput < Struct.new(
  :identity_pool_id,
  :identity_id,
  :developer_user_identifier,
  :max_results,
  :next_token)
  include Aws::Structure
end

#identity_idString

A unique identifier in the format REGION:GUID.

Returns:

  • (String)


803
804
805
806
807
808
809
810
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 803

class LookupDeveloperIdentityInput < Struct.new(
  :identity_pool_id,
  :identity_id,
  :developer_user_identifier,
  :max_results,
  :next_token)
  include Aws::Structure
end

#identity_pool_idString

An identity pool ID in the format REGION:GUID.

Returns:

  • (String)


803
804
805
806
807
808
809
810
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 803

class LookupDeveloperIdentityInput < Struct.new(
  :identity_pool_id,
  :identity_id,
  :developer_user_identifier,
  :max_results,
  :next_token)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of identities to return.

Returns:

  • (Integer)


803
804
805
806
807
808
809
810
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 803

class LookupDeveloperIdentityInput < Struct.new(
  :identity_pool_id,
  :identity_id,
  :developer_user_identifier,
  :max_results,
  :next_token)
  include Aws::Structure
end

#next_tokenString

A pagination token. The first call you make will have NextToken set to null. After that the service will return NextToken values as needed. For example, let's say you make a request with MaxResults set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match.

Returns:

  • (String)


803
804
805
806
807
808
809
810
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 803

class LookupDeveloperIdentityInput < Struct.new(
  :identity_pool_id,
  :identity_id,
  :developer_user_identifier,
  :max_results,
  :next_token)
  include Aws::Structure
end