AdminInitiateAuthRequest (AWS SDK for Android - Amazon Cognito Identity Provider 2.6.23 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.cognitoidentityprovider.model.AdminInitiateAuthRequest

All Implemented Interfaces:

Serializable, Cloneable
```
public class AdminInitiateAuthRequest
extends AmazonWebServiceRequest
implements Serializable
```
Initiates the authentication flow, as an administrator.

Requires developer credentials.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

AdminInitiateAuthRequest()

Constructors
Constructor and Description
`AdminInitiateAuthRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AdminInitiateAuthRequest`	`addAuthParametersEntry(String key, String value)` The authentication parameters.
`AdminInitiateAuthRequest`	`addClientMetadataEntry(String key, String value)` This is a random key-value pair map which can contain any key and will be passed to your PreAuthentication Lambda trigger as-is.
`AdminInitiateAuthRequest`	`clearAuthParametersEntries()` Removes all the entries added into AuthParameters.
`AdminInitiateAuthRequest`	`clearClientMetadataEntries()` Removes all the entries added into ClientMetadata.
`boolean`	`equals(Object obj)`
`AnalyticsMetadataType`	`getAnalyticsMetadata()` The analytics metadata for collecting Amazon Pinpoint metrics for `AdminInitiateAuth` calls.
`String`	`getAuthFlow()` The authentication flow for this call to execute.
`Map<String,String>`	`getAuthParameters()` The authentication parameters.
`String`	`getClientId()` The app client ID.
`Map<String,String>`	`getClientMetadata()` This is a random key-value pair map which can contain any key and will be passed to your PreAuthentication Lambda trigger as-is.
`ContextDataType`	`getContextData()` Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
`String`	`getUserPoolId()` The ID of the Amazon Cognito user pool.
`int`	`hashCode()`
`void`	`setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)` The analytics metadata for collecting Amazon Pinpoint metrics for `AdminInitiateAuth` calls.
`void`	`setAuthFlow(AuthFlowType authFlow)` The authentication flow for this call to execute.
`void`	`setAuthFlow(String authFlow)` The authentication flow for this call to execute.
`void`	`setAuthParameters(Map<String,String> authParameters)` The authentication parameters.
`void`	`setClientId(String clientId)` The app client ID.
`void`	`setClientMetadata(Map<String,String> clientMetadata)` This is a random key-value pair map which can contain any key and will be passed to your PreAuthentication Lambda trigger as-is.
`void`	`setContextData(ContextDataType contextData)` Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
`void`	`setUserPoolId(String userPoolId)` The ID of the Amazon Cognito user pool.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`AdminInitiateAuthRequest`	`withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)` The analytics metadata for collecting Amazon Pinpoint metrics for `AdminInitiateAuth` calls.
`AdminInitiateAuthRequest`	`withAuthFlow(AuthFlowType authFlow)` The authentication flow for this call to execute.
`AdminInitiateAuthRequest`	`withAuthFlow(String authFlow)` The authentication flow for this call to execute.
`AdminInitiateAuthRequest`	`withAuthParameters(Map<String,String> authParameters)` The authentication parameters.
`AdminInitiateAuthRequest`	`withClientId(String clientId)` The app client ID.
`AdminInitiateAuthRequest`	`withClientMetadata(Map<String,String> clientMetadata)` This is a random key-value pair map which can contain any key and will be passed to your PreAuthentication Lambda trigger as-is.
`AdminInitiateAuthRequest`	`withContextData(ContextDataType contextData)` Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
`AdminInitiateAuthRequest`	`withUserPoolId(String userPoolId)` The ID of the Amazon Cognito user pool.

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
  - AdminInitiateAuthRequest
```
public AdminInitiateAuthRequest()
```
- Method Detail
  - getUserPoolId
```
public String getUserPoolId()
```
    The ID of the Amazon Cognito user pool.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Returns:
    
    The ID of the Amazon Cognito user pool.
  - setUserPoolId
```
public void setUserPoolId(String userPoolId)
```
    The ID of the Amazon Cognito user pool.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Parameters:
    
    userPoolId -
    The ID of the Amazon Cognito user pool.
  - withUserPoolId
```
public AdminInitiateAuthRequest withUserPoolId(String userPoolId)
```
    The ID of the Amazon Cognito user pool.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Parameters:
    
    userPoolId -
    The ID of the Amazon Cognito user pool.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getClientId
```
public String getClientId()
```
    The app client ID.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w+]+
    
    Returns:
    
    The app client ID.
  - setClientId
```
public void setClientId(String clientId)
```
    The app client ID.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w+]+
    
    Parameters:
    
    clientId -
    The app client ID.
  - withClientId
```
public AdminInitiateAuthRequest withClientId(String clientId)
```
    The app 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 app client ID.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAuthFlow
```
public String getAuthFlow()
```
    The authentication flow for this call to execute. The API action will depend on this value. For example:
    - REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens.
    - USER_SRP_AUTH will take in USERNAME and SRP_A and return the SRP variables to be used for next challenge execution.
    - USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next challenge or tokens.
    Valid values include:
    - USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.
    - REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.
    - CUSTOM_AUTH: Custom authentication flow.
    - ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.
    - USER_PASSWORD_AUTH: Non-SRP authentication flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if the USERNAME is not found in the user pool.
    Constraints:
    Allowed Values: USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN, CUSTOM_AUTH, ADMIN_NO_SRP_AUTH, USER_PASSWORD_AUTH
    Returns:
    The authentication flow for this call to execute. The API action will depend on this value. For example:
    
    REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens.
    
    USER_SRP_AUTH will take in USERNAME and SRP_A and return the SRP variables to be used for next challenge execution.
    
    USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next challenge or tokens.
    
    Valid values include:
    
    USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.
    
    REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.
    
    CUSTOM_AUTH: Custom authentication flow.
    
    ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.
    
    USER_PASSWORD_AUTH: Non-SRP authentication flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if the USERNAME is not found in the user pool.
    See Also:
    
    AuthFlowType
  - setAuthFlow
```
public void setAuthFlow(String authFlow)
```
    The authentication flow for this call to execute. The API action will depend on this value. For example:
    - REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens.
    - USER_SRP_AUTH will take in USERNAME and SRP_A and return the SRP variables to be used for next challenge execution.
    - USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next challenge or tokens.
    Valid values include:
    - USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.
    - REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.
    - CUSTOM_AUTH: Custom authentication flow.
    - ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.
    - USER_PASSWORD_AUTH: Non-SRP authentication flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if the USERNAME is not found in the user pool.
    Constraints:
    Allowed Values: USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN, CUSTOM_AUTH, ADMIN_NO_SRP_AUTH, USER_PASSWORD_AUTH
    Parameters:
    authFlow -
    The authentication flow for this call to execute. The API action will depend on this value. For example:
    
    REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens.
    
    USER_SRP_AUTH will take in USERNAME and SRP_A and return the SRP variables to be used for next challenge execution.
    
    USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next challenge or tokens.
    
    Valid values include:
    
    USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.
    
    REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.
    
    CUSTOM_AUTH: Custom authentication flow.
    
    ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.
    
    USER_PASSWORD_AUTH: Non-SRP authentication flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if the USERNAME is not found in the user pool.
    See Also:
    
    AuthFlowType
  - withAuthFlow
```
public AdminInitiateAuthRequest withAuthFlow(String authFlow)
```
    The authentication flow for this call to execute. The API action will depend on this value. For example:
    - REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens.
    - USER_SRP_AUTH will take in USERNAME and SRP_A and return the SRP variables to be used for next challenge execution.
    - USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next challenge or tokens.
    Valid values include:
    - USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.
    - REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.
    - CUSTOM_AUTH: Custom authentication flow.
    - ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.
    - USER_PASSWORD_AUTH: Non-SRP authentication flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if the USERNAME is not found in the user pool.
    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, USER_PASSWORD_AUTH
    Parameters:
    authFlow -
    The authentication flow for this call to execute. The API action will depend on this value. For example:
    
    REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens.
    
    USER_SRP_AUTH will take in USERNAME and SRP_A and return the SRP variables to be used for next challenge execution.
    
    USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next challenge or tokens.
    
    Valid values include:
    
    USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.
    
    REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.
    
    CUSTOM_AUTH: Custom authentication flow.
    
    ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.
    
    USER_PASSWORD_AUTH: Non-SRP authentication flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if the USERNAME is not found in the user pool.
    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 for this call to execute. The API action will depend on this value. For example:
    - REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens.
    - USER_SRP_AUTH will take in USERNAME and SRP_A and return the SRP variables to be used for next challenge execution.
    - USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next challenge or tokens.
    Valid values include:
    - USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.
    - REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.
    - CUSTOM_AUTH: Custom authentication flow.
    - ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.
    - USER_PASSWORD_AUTH: Non-SRP authentication flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if the USERNAME is not found in the user pool.
    Constraints:
    Allowed Values: USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN, CUSTOM_AUTH, ADMIN_NO_SRP_AUTH, USER_PASSWORD_AUTH
    Parameters:
    authFlow -
    The authentication flow for this call to execute. The API action will depend on this value. For example:
    
    REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens.
    
    USER_SRP_AUTH will take in USERNAME and SRP_A and return the SRP variables to be used for next challenge execution.
    
    USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next challenge or tokens.
    
    Valid values include:
    
    USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.
    
    REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.
    
    CUSTOM_AUTH: Custom authentication flow.
    
    ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.
    
    USER_PASSWORD_AUTH: Non-SRP authentication flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if the USERNAME is not found in the user pool.
    See Also:
    
    AuthFlowType
  - withAuthFlow
```
public AdminInitiateAuthRequest withAuthFlow(AuthFlowType authFlow)
```
    The authentication flow for this call to execute. The API action will depend on this value. For example:
    - REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens.
    - USER_SRP_AUTH will take in USERNAME and SRP_A and return the SRP variables to be used for next challenge execution.
    - USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next challenge or tokens.
    Valid values include:
    - USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.
    - REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.
    - CUSTOM_AUTH: Custom authentication flow.
    - ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.
    - USER_PASSWORD_AUTH: Non-SRP authentication flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if the USERNAME is not found in the user pool.
    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, USER_PASSWORD_AUTH
    Parameters:
    authFlow -
    The authentication flow for this call to execute. The API action will depend on this value. For example:
    
    REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens.
    
    USER_SRP_AUTH will take in USERNAME and SRP_A and return the SRP variables to be used for next challenge execution.
    
    USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next challenge or tokens.
    
    Valid values include:
    
    USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.
    
    REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.
    
    CUSTOM_AUTH: Custom authentication flow.
    
    ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.
    
    USER_PASSWORD_AUTH: Non-SRP authentication flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if the USERNAME is not found in the user pool.
    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. These are inputs corresponding to the AuthFlow that you are invoking. The required values depend on the value of AuthFlow:
    - For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY
    - For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY
    - For ADMIN_NO_SRP_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), PASSWORD (required), DEVICE_KEY
    - For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY
    Returns:
    The authentication parameters. These are inputs corresponding to the AuthFlow that you are invoking. The required values depend on the value of AuthFlow:
    
    For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY
    
    For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY
    
    For ADMIN_NO_SRP_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), PASSWORD (required), DEVICE_KEY
    
    For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY
  - setAuthParameters
```
public void setAuthParameters(Map<String,String> authParameters)
```
    The authentication parameters. These are inputs corresponding to the AuthFlow that you are invoking. The required values depend on the value of AuthFlow:
    - For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY
    - For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY
    - For ADMIN_NO_SRP_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), PASSWORD (required), DEVICE_KEY
    - For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY
    Parameters:
    authParameters -
    The authentication parameters. These are inputs corresponding to the AuthFlow that you are invoking. The required values depend on the value of AuthFlow:
    
    For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY
    
    For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY
    
    For ADMIN_NO_SRP_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), PASSWORD (required), DEVICE_KEY
    
    For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY
  - withAuthParameters
```
public AdminInitiateAuthRequest withAuthParameters(Map<String,String> authParameters)
```
    The authentication parameters. These are inputs corresponding to the AuthFlow that you are invoking. The required values depend on the value of AuthFlow:
    - For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY
    - For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY
    - For ADMIN_NO_SRP_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), PASSWORD (required), DEVICE_KEY
    - For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY
    Returns a reference to this object so that method calls can be chained together.
    Parameters:
    authParameters -
    The authentication parameters. These are inputs corresponding to the AuthFlow that you are invoking. The required values depend on the value of AuthFlow:
    
    For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY
    
    For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY
    
    For ADMIN_NO_SRP_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), PASSWORD (required), DEVICE_KEY
    
    For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addAuthParametersEntry
```
public AdminInitiateAuthRequest addAuthParametersEntry(String key,
                                                       String value)
```
    The authentication parameters. These are inputs corresponding to the AuthFlow that you are invoking. The required values depend on the value of AuthFlow:
    - For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY
    - For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY
    - For ADMIN_NO_SRP_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), PASSWORD (required), DEVICE_KEY
    - For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY
    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 AdminInitiateAuthRequest 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()
```
    This is a random key-value pair map which can contain any key and will be passed to your PreAuthentication Lambda trigger as-is. It can be used to implement additional validations around authentication.
    
    Returns:
    
    This is a random key-value pair map which can contain any key and will be passed to your PreAuthentication Lambda trigger as-is. It can be used to implement additional validations around authentication.
  - setClientMetadata
```
public void setClientMetadata(Map<String,String> clientMetadata)
```
    This is a random key-value pair map which can contain any key and will be passed to your PreAuthentication Lambda trigger as-is. It can be used to implement additional validations around authentication.
    
    Parameters:
    
    clientMetadata -
    This is a random key-value pair map which can contain any key and will be passed to your PreAuthentication Lambda trigger as-is. It can be used to implement additional validations around authentication.
  - withClientMetadata
```
public AdminInitiateAuthRequest withClientMetadata(Map<String,String> clientMetadata)
```
    This is a random key-value pair map which can contain any key and will be passed to your PreAuthentication Lambda trigger as-is. It can be used to implement additional validations around authentication.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    clientMetadata -
    This is a random key-value pair map which can contain any key and will be passed to your PreAuthentication Lambda trigger as-is. It can be used to implement additional validations around authentication.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addClientMetadataEntry
```
public AdminInitiateAuthRequest addClientMetadataEntry(String key,
                                                       String value)
```
    This is a random key-value pair map which can contain any key and will be passed to your PreAuthentication Lambda trigger as-is. It can be used to implement additional validations around authentication.
    
    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 AdminInitiateAuthRequest clearClientMetadataEntries()
```
    Removes all the entries added into ClientMetadata.
    Returns a reference to this object so that method calls can be chained together.
  - getAnalyticsMetadata
```
public AnalyticsMetadataType getAnalyticsMetadata()
```
    The analytics metadata for collecting Amazon Pinpoint metrics for AdminInitiateAuth calls.
    
    Returns:
    
    The analytics metadata for collecting Amazon Pinpoint metrics for AdminInitiateAuth calls.
  - setAnalyticsMetadata
```
public void setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)
```
    The analytics metadata for collecting Amazon Pinpoint metrics for AdminInitiateAuth calls.
    
    Parameters:
    
    analyticsMetadata -
    The analytics metadata for collecting Amazon Pinpoint metrics for AdminInitiateAuth calls.
  - withAnalyticsMetadata
```
public AdminInitiateAuthRequest withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)
```
    The analytics metadata for collecting Amazon Pinpoint metrics for AdminInitiateAuth calls.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    analyticsMetadata -
    The analytics metadata for collecting Amazon Pinpoint metrics for AdminInitiateAuth calls.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getContextData
```
public ContextDataType getContextData()
```
    Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
    
    Returns:
    
    Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
  - setContextData
```
public void setContextData(ContextDataType contextData)
```
    Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
    
    Parameters:
    
    contextData -
    Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
  - withContextData
```
public AdminInitiateAuthRequest withContextData(ContextDataType contextData)
```
    Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    contextData -
    Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
    
    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

Class AdminInitiateAuthRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

AdminInitiateAuthRequest

Method Detail

getUserPoolId

setUserPoolId

withUserPoolId

getClientId

setClientId

withClientId

getAuthFlow

setAuthFlow

withAuthFlow

setAuthFlow

withAuthFlow

getAuthParameters

setAuthParameters

withAuthParameters

addAuthParametersEntry

clearAuthParametersEntries

getClientMetadata

setClientMetadata

withClientMetadata

addClientMetadataEntry

clearClientMetadataEntries

getAnalyticsMetadata

setAnalyticsMetadata

withAnalyticsMetadata

getContextData

setContextData

withContextData

toString

hashCode

equals