com.amazonaws.services.cognitoidentity.model

Class GetIdRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentity.model.GetIdRequest

All Implemented Interfaces:

Serializable, Cloneable

public class GetIdRequest
extends AmazonWebServiceRequest
implements Serializable

Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.

This is a public API. You do not need any credentials to call this API.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetIdRequest()

Method Summary

Modifier and Type	Method and Description
GetIdRequest	addLoginsEntry(String key, String value) A set of optional name-value pairs that map provider names to provider tokens.
GetIdRequest	clearLoginsEntries() Removes all the entries added into Logins.
boolean	equals(Object obj)
String	getAccountId() A standard AWS account ID (9+ digits).
String	getIdentityPoolId() An identity pool ID in the format REGION:GUID.
Map<String,String>	getLogins() A set of optional name-value pairs that map provider names to provider tokens.
int	hashCode()
void	setAccountId(String accountId) A standard AWS account ID (9+ digits).
void	setIdentityPoolId(String identityPoolId) An identity pool ID in the format REGION:GUID.
void	setLogins(Map<String,String> logins) A set of optional name-value pairs that map provider names to provider tokens.
String	toString() Returns a string representation of this object; useful for testing and debugging.
GetIdRequest	withAccountId(String accountId) A standard AWS account ID (9+ digits).
GetIdRequest	withIdentityPoolId(String identityPoolId) An identity pool ID in the format REGION:GUID.
GetIdRequest	withLogins(Map<String,String> logins) A set of optional name-value pairs that map provider names to provider tokens.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetIdRequest

public GetIdRequest()

Method Detail

getAccountId

public String getAccountId()

A standard AWS account ID (9+ digits).

Constraints:
Length: 1 - 15
Pattern: \d+

Returns:

A standard AWS account ID (9+ digits).

setAccountId

public void setAccountId(String accountId)

A standard AWS account ID (9+ digits).

Constraints:
Length: 1 - 15
Pattern: \d+

Parameters:

accountId -

A standard AWS account ID (9+ digits).

withAccountId

public GetIdRequest withAccountId(String accountId)

A standard AWS account ID (9+ digits).

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 15
Pattern: \d+

Parameters:

accountId -

A standard AWS account ID (9+ digits).

Returns:

A reference to this updated object so that method calls can be chained together.

getIdentityPoolId

public String getIdentityPoolId()

An identity pool ID in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

Returns:

An identity pool ID in the format REGION:GUID.

setIdentityPoolId

public void setIdentityPoolId(String identityPoolId)

An identity pool ID in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

Parameters:

identityPoolId -

An identity pool ID in the format REGION:GUID.

withIdentityPoolId

public GetIdRequest withIdentityPoolId(String identityPoolId)

An identity pool ID in the format REGION:GUID.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

Parameters:

identityPoolId -

An identity pool ID in the format REGION:GUID.

Returns:

A reference to this updated object so that method calls can be chained together.

getLogins

public Map<String,String> getLogins()

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 user pool: cognito-idp.<region>.amazonaws.com/<YOUR_USER_POOL_ID> , for example, 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:

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 user pool: cognito-idp.<region>.amazonaws.com/<YOUR_USER_POOL_ID> , for example, 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

setLogins

public void setLogins(Map<String,String> logins)

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 user pool: cognito-idp.<region>.amazonaws.com/<YOUR_USER_POOL_ID> , for example, 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

Parameters:

logins -

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 user pool: cognito-idp.<region>.amazonaws.com/<YOUR_USER_POOL_ID> , for example, 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

withLogins

public GetIdRequest withLogins(Map<String,String> logins)

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 user pool: cognito-idp.<region>.amazonaws.com/<YOUR_USER_POOL_ID> , for example, 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 a reference to this object so that method calls can be chained together.

Parameters:

logins -

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 user pool: cognito-idp.<region>.amazonaws.com/<YOUR_USER_POOL_ID> , for example, 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:

A reference to this updated object so that method calls can be chained together.

addLoginsEntry

public GetIdRequest addLoginsEntry(String key,
                                   String value)

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 user pool: cognito-idp.<region>.amazonaws.com/<YOUR_USER_POOL_ID> , for example, 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

The method adds a new key-value pair into Logins parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into Logins.

value - The corresponding value of the entry to be added into Logins.

Returns:

A reference to this updated object so that method calls can be chained together.

clearLoginsEntries

public GetIdRequest clearLoginsEntries()

Removes all the entries added into Logins.

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object