com.amazonaws.services.cognitoidentityprovider.model

Class InitiateAuthRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.InitiateAuthRequest

All Implemented Interfaces:

Serializable, Cloneable

public class InitiateAuthRequest
extends AmazonWebServiceRequest
implements Serializable

Initiates the authentication flow.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
InitiateAuthRequest()

Method Summary

Modifier and Type	Method and Description
InitiateAuthRequest	addAuthParametersEntry(String key, String value) The authentication parameters.
InitiateAuthRequest	addClientMetadataEntry(String key, String value) The client app's metadata.
InitiateAuthRequest	clearAuthParametersEntries() Removes all the entries added into AuthParameters.
InitiateAuthRequest	clearClientMetadataEntries() Removes all the entries added into ClientMetadata.
boolean	equals(Object obj)
AnalyticsMetadataType	getAnalyticsMetadata() The pinpoint installation id.
String	getAuthFlow() The authentication flow.
Map<String,String>	getAuthParameters() The authentication parameters.
String	getClientId() The client ID.
Map<String,String>	getClientMetadata() The client app's metadata.
UserContextDataType	getUserContextData() Base64 encoded string for user context data collected for risk evaluation
int	hashCode()
void	setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata) The pinpoint installation id.
void	setAuthFlow(AuthFlowType authFlow) The authentication flow.
void	setAuthFlow(String authFlow) The authentication flow.
void	setAuthParameters(Map<String,String> authParameters) The authentication parameters.
void	setClientId(String clientId) The client ID.
void	setClientMetadata(Map<String,String> clientMetadata) The client app's metadata.
void	setUserContextData(UserContextDataType userContextData) Base64 encoded string for user context data collected for risk evaluation
String	toString() Returns a string representation of this object; useful for testing and debugging.
InitiateAuthRequest	withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata) The pinpoint installation id.
InitiateAuthRequest	withAuthFlow(AuthFlowType authFlow) The authentication flow.
InitiateAuthRequest	withAuthFlow(String authFlow) The authentication flow.
InitiateAuthRequest	withAuthParameters(Map<String,String> authParameters) The authentication parameters.
InitiateAuthRequest	withClientId(String clientId) The client ID.
InitiateAuthRequest	withClientMetadata(Map<String,String> clientMetadata) The client app's metadata.
InitiateAuthRequest	withUserContextData(UserContextDataType userContextData) Base64 encoded string for user context data collected for risk evaluation

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

InitiateAuthRequest

public InitiateAuthRequest()

Method Detail

getAuthFlow

public String getAuthFlow()

The authentication flow.

Constraints:
Allowed Values: USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN, CUSTOM_AUTH, ADMIN_NO_SRP_AUTH

Returns:

The authentication flow.

See Also:

AuthFlowType

setAuthFlow

public void setAuthFlow(String authFlow)

The authentication flow.

Constraints:
Allowed Values: USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN, CUSTOM_AUTH, ADMIN_NO_SRP_AUTH

Parameters:

authFlow -

The authentication flow.

See Also:

AuthFlowType

withAuthFlow

public InitiateAuthRequest withAuthFlow(String authFlow)

The authentication flow.

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

Constraints:
Allowed Values: USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN, CUSTOM_AUTH, ADMIN_NO_SRP_AUTH

Parameters:

authFlow -

The authentication flow.

Returns:

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

See Also:

AuthFlowType

setAuthFlow

public void setAuthFlow(AuthFlowType authFlow)

The authentication flow.

Constraints:
Allowed Values: USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN, CUSTOM_AUTH, ADMIN_NO_SRP_AUTH

Parameters:

authFlow -

The authentication flow.

See Also:

AuthFlowType

withAuthFlow

public InitiateAuthRequest withAuthFlow(AuthFlowType authFlow)

The authentication flow.

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

Constraints:
Allowed Values: USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN, CUSTOM_AUTH, ADMIN_NO_SRP_AUTH

Parameters:

authFlow -

The authentication flow.

Returns:

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

See Also:

AuthFlowType

getAuthParameters

public Map<String,String> getAuthParameters()

The authentication parameters.

Returns:

The authentication parameters.

setAuthParameters

public void setAuthParameters(Map<String,String> authParameters)

The authentication parameters.

Parameters:

authParameters -

The authentication parameters.

withAuthParameters

public InitiateAuthRequest withAuthParameters(Map<String,String> authParameters)

The authentication parameters.

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

Parameters:

authParameters -

The authentication parameters.

Returns:

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

addAuthParametersEntry

public InitiateAuthRequest addAuthParametersEntry(String key,
                                                  String value)

The authentication parameters.

The method adds a new key-value pair into AuthParameters 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 AuthParameters.

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

Returns:

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

clearAuthParametersEntries

public InitiateAuthRequest clearAuthParametersEntries()

Removes all the entries added into AuthParameters.

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

getClientMetadata

public Map<String,String> getClientMetadata()

The client app's metadata.

Returns:

The client app's metadata.

setClientMetadata

public void setClientMetadata(Map<String,String> clientMetadata)

The client app's metadata.

Parameters:

clientMetadata -

The client app's metadata.

withClientMetadata

public InitiateAuthRequest withClientMetadata(Map<String,String> clientMetadata)

The client app's metadata.

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

Parameters:

clientMetadata -

The client app's metadata.

Returns:

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

addClientMetadataEntry

public InitiateAuthRequest addClientMetadataEntry(String key,
                                                  String value)

The client app's metadata.

The method adds a new key-value pair into ClientMetadata 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 ClientMetadata.

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

Returns:

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

clearClientMetadataEntries

public InitiateAuthRequest clearClientMetadataEntries()

Removes all the entries added into ClientMetadata.

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

getClientId

public String getClientId()

The client ID.

Constraints:
Length: 1 - 128
Pattern: [\w+]+

Returns:

The client ID.

setClientId

public void setClientId(String clientId)

The client ID.

Constraints:
Length: 1 - 128
Pattern: [\w+]+

Parameters:

clientId -

The client ID.

withClientId

public InitiateAuthRequest withClientId(String clientId)

The client ID.

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

Constraints:
Length: 1 - 128
Pattern: [\w+]+

Parameters:

clientId -

The client ID.

Returns:

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

getUserContextData

public UserContextDataType getUserContextData()

Base64 encoded string for user context data collected for risk evaluation

Returns:

Base64 encoded string for user context data collected for risk evaluation

setUserContextData

public void setUserContextData(UserContextDataType userContextData)

Base64 encoded string for user context data collected for risk evaluation

Parameters:

userContextData -

Base64 encoded string for user context data collected for risk evaluation

withUserContextData

public InitiateAuthRequest withUserContextData(UserContextDataType userContextData)

Base64 encoded string for user context data collected for risk evaluation

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

Parameters:

userContextData -

Base64 encoded string for user context data collected for risk evaluation

Returns:

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

getAnalyticsMetadata

public AnalyticsMetadataType getAnalyticsMetadata()

The pinpoint installation id.

Returns:

The pinpoint installation id.

setAnalyticsMetadata

public void setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)

The pinpoint installation id.

Parameters:

analyticsMetadata -

The pinpoint installation id.

withAnalyticsMetadata

public InitiateAuthRequest withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)

The pinpoint installation id.

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

Parameters:

analyticsMetadata -

The pinpoint installation id.

Returns:

A reference to this updated 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