InitiateAuthRequest (aws-android-sdk-cognitoidentityprovider 2.81.1 API)

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class InitiateAuthRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
```
Initiates sign-in for a user in the Amazon Cognito user directory. You can't sign in a user with a federated IdP with InitiateAuth. For more information, see Adding user pool sign-in through a third party.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

InitiateAuthRequest()

Constructors
Constructor and Description
`InitiateAuthRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InitiateAuthRequest`	`addAuthParametersEntry(java.lang.String key, java.lang.String value)` The authentication parameters.
`InitiateAuthRequest`	`addClientMetadataEntry(java.lang.String key, java.lang.String value)` A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.
`InitiateAuthRequest`	`clearAuthParametersEntries()` Removes all the entries added into AuthParameters.
`InitiateAuthRequest`	`clearClientMetadataEntries()` Removes all the entries added into ClientMetadata.
`boolean`	`equals(java.lang.Object obj)`
`AnalyticsMetadataType`	`getAnalyticsMetadata()` The Amazon Pinpoint analytics metadata that contributes to your metrics for `InitiateAuth` calls.
`java.lang.String`	`getAuthFlow()` The authentication flow for this call to run.
`java.util.Map<java.lang.String,java.lang.String>`	`getAuthParameters()` The authentication parameters.
`java.lang.String`	`getClientId()` The app client ID.
`java.util.Map<java.lang.String,java.lang.String>`	`getClientMetadata()` A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.
`UserContextDataType`	`getUserContextData()` Contextual data about your user session, such as the device fingerprint, IP address, or location.
`int`	`hashCode()`
`void`	`setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)` The Amazon Pinpoint analytics metadata that contributes to your metrics for `InitiateAuth` calls.
`void`	`setAuthFlow(AuthFlowType authFlow)` The authentication flow for this call to run.
`void`	`setAuthFlow(java.lang.String authFlow)` The authentication flow for this call to run.
`void`	`setAuthParameters(java.util.Map<java.lang.String,java.lang.String> authParameters)` The authentication parameters.
`void`	`setClientId(java.lang.String clientId)` The app client ID.
`void`	`setClientMetadata(java.util.Map<java.lang.String,java.lang.String> clientMetadata)` A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.
`void`	`setUserContextData(UserContextDataType userContextData)` Contextual data about your user session, such as the device fingerprint, IP address, or location.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`InitiateAuthRequest`	`withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)` The Amazon Pinpoint analytics metadata that contributes to your metrics for `InitiateAuth` calls.
`InitiateAuthRequest`	`withAuthFlow(AuthFlowType authFlow)` The authentication flow for this call to run.
`InitiateAuthRequest`	`withAuthFlow(java.lang.String authFlow)` The authentication flow for this call to run.
`InitiateAuthRequest`	`withAuthParameters(java.util.Map<java.lang.String,java.lang.String> authParameters)` The authentication parameters.
`InitiateAuthRequest`	`withClientId(java.lang.String clientId)` The app client ID.
`InitiateAuthRequest`	`withClientMetadata(java.util.Map<java.lang.String,java.lang.String> clientMetadata)` A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.
`InitiateAuthRequest`	`withUserContextData(UserContextDataType userContextData)` Contextual data about your user session, such as the device fingerprint, IP address, or location.

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 java.lang.String getAuthFlow()
```
    The authentication flow for this call to run. The API action will depend on this value. For example:
    - REFRESH_TOKEN_AUTH takes in a valid refresh token and returns new tokens.
    - USER_SRP_AUTH takes in USERNAME and SRP_A and returns the SRP variables to be used for next challenge execution.
    - USER_PASSWORD_AUTH takes in USERNAME and PASSWORD and returns 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.
    - USER_PASSWORD_AUTH: Non-SRP authentication flow; user name and password are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn't find the user name in the user pool.
    ADMIN_NO_SRP_AUTH isn't a valid value.
    
    Constraints:
    Allowed Values: USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN, CUSTOM_AUTH, ADMIN_NO_SRP_AUTH, USER_PASSWORD_AUTH, ADMIN_USER_PASSWORD_AUTH
    Returns:
    The authentication flow for this call to run. The API action will depend on this value. For example:
    
    REFRESH_TOKEN_AUTH takes in a valid refresh token and returns new tokens.
    
    USER_SRP_AUTH takes in USERNAME and SRP_A and returns the SRP variables to be used for next challenge execution.
    
    USER_PASSWORD_AUTH takes in USERNAME and PASSWORD and returns 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.
    
    USER_PASSWORD_AUTH: Non-SRP authentication flow; user name and password are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn't find the user name in the user pool.
    
    ADMIN_NO_SRP_AUTH isn't a valid value.
    See Also:
    
    AuthFlowType
  - setAuthFlow
```
public void setAuthFlow(java.lang.String authFlow)
```
    The authentication flow for this call to run. The API action will depend on this value. For example:
    - REFRESH_TOKEN_AUTH takes in a valid refresh token and returns new tokens.
    - USER_SRP_AUTH takes in USERNAME and SRP_A and returns the SRP variables to be used for next challenge execution.
    - USER_PASSWORD_AUTH takes in USERNAME and PASSWORD and returns 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.
    - USER_PASSWORD_AUTH: Non-SRP authentication flow; user name and password are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn't find the user name in the user pool.
    ADMIN_NO_SRP_AUTH isn't a valid value.
    
    Constraints:
    Allowed Values: USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN, CUSTOM_AUTH, ADMIN_NO_SRP_AUTH, USER_PASSWORD_AUTH, ADMIN_USER_PASSWORD_AUTH
    Parameters:
    authFlow -
    The authentication flow for this call to run. The API action will depend on this value. For example:
    
    REFRESH_TOKEN_AUTH takes in a valid refresh token and returns new tokens.
    
    USER_SRP_AUTH takes in USERNAME and SRP_A and returns the SRP variables to be used for next challenge execution.
    
    USER_PASSWORD_AUTH takes in USERNAME and PASSWORD and returns 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.
    
    USER_PASSWORD_AUTH: Non-SRP authentication flow; user name and password are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn't find the user name in the user pool.
    
    ADMIN_NO_SRP_AUTH isn't a valid value.
    See Also:
    
    AuthFlowType
  - withAuthFlow
```
public InitiateAuthRequest withAuthFlow(java.lang.String authFlow)
```
    The authentication flow for this call to run. The API action will depend on this value. For example:
    - REFRESH_TOKEN_AUTH takes in a valid refresh token and returns new tokens.
    - USER_SRP_AUTH takes in USERNAME and SRP_A and returns the SRP variables to be used for next challenge execution.
    - USER_PASSWORD_AUTH takes in USERNAME and PASSWORD and returns 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.
    - USER_PASSWORD_AUTH: Non-SRP authentication flow; user name and password are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn't find the user name in the user pool.
    ADMIN_NO_SRP_AUTH isn't a valid value.
    
    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, ADMIN_USER_PASSWORD_AUTH
    Parameters:
    authFlow -
    The authentication flow for this call to run. The API action will depend on this value. For example:
    
    REFRESH_TOKEN_AUTH takes in a valid refresh token and returns new tokens.
    
    USER_SRP_AUTH takes in USERNAME and SRP_A and returns the SRP variables to be used for next challenge execution.
    
    USER_PASSWORD_AUTH takes in USERNAME and PASSWORD and returns 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.
    
    USER_PASSWORD_AUTH: Non-SRP authentication flow; user name and password are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn't find the user name in the user pool.
    
    ADMIN_NO_SRP_AUTH isn't a valid value.
    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 run. The API action will depend on this value. For example:
    - REFRESH_TOKEN_AUTH takes in a valid refresh token and returns new tokens.
    - USER_SRP_AUTH takes in USERNAME and SRP_A and returns the SRP variables to be used for next challenge execution.
    - USER_PASSWORD_AUTH takes in USERNAME and PASSWORD and returns 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.
    - USER_PASSWORD_AUTH: Non-SRP authentication flow; user name and password are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn't find the user name in the user pool.
    ADMIN_NO_SRP_AUTH isn't a valid value.
    
    Constraints:
    Allowed Values: USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN, CUSTOM_AUTH, ADMIN_NO_SRP_AUTH, USER_PASSWORD_AUTH, ADMIN_USER_PASSWORD_AUTH
    Parameters:
    authFlow -
    The authentication flow for this call to run. The API action will depend on this value. For example:
    
    REFRESH_TOKEN_AUTH takes in a valid refresh token and returns new tokens.
    
    USER_SRP_AUTH takes in USERNAME and SRP_A and returns the SRP variables to be used for next challenge execution.
    
    USER_PASSWORD_AUTH takes in USERNAME and PASSWORD and returns 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.
    
    USER_PASSWORD_AUTH: Non-SRP authentication flow; user name and password are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn't find the user name in the user pool.
    
    ADMIN_NO_SRP_AUTH isn't a valid value.
    See Also:
    
    AuthFlowType
  - withAuthFlow
```
public InitiateAuthRequest withAuthFlow(AuthFlowType authFlow)
```
    The authentication flow for this call to run. The API action will depend on this value. For example:
    - REFRESH_TOKEN_AUTH takes in a valid refresh token and returns new tokens.
    - USER_SRP_AUTH takes in USERNAME and SRP_A and returns the SRP variables to be used for next challenge execution.
    - USER_PASSWORD_AUTH takes in USERNAME and PASSWORD and returns 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.
    - USER_PASSWORD_AUTH: Non-SRP authentication flow; user name and password are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn't find the user name in the user pool.
    ADMIN_NO_SRP_AUTH isn't a valid value.
    
    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, ADMIN_USER_PASSWORD_AUTH
    Parameters:
    authFlow -
    The authentication flow for this call to run. The API action will depend on this value. For example:
    
    REFRESH_TOKEN_AUTH takes in a valid refresh token and returns new tokens.
    
    USER_SRP_AUTH takes in USERNAME and SRP_A and returns the SRP variables to be used for next challenge execution.
    
    USER_PASSWORD_AUTH takes in USERNAME and PASSWORD and returns 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.
    
    USER_PASSWORD_AUTH: Non-SRP authentication flow; user name and password are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn't find the user name in the user pool.
    
    ADMIN_NO_SRP_AUTH isn't a valid value.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    AuthFlowType
  - getAuthParameters
```
public java.util.Map<java.lang.String,java.lang.String> getAuthParameters()
```
    The authentication parameters. These are inputs corresponding to the AuthFlow that you're 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 USER_PASSWORD_AUTH: USERNAME (required), PASSWORD (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 CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY. To start the authentication flow with password verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value).
    For more information about SECRET_HASH, see Computing secret hash values. For information about DEVICE_KEY, see Working with user devices in your user pool.
    Returns:
    The authentication parameters. These are inputs corresponding to the AuthFlow that you're 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 USER_PASSWORD_AUTH: USERNAME (required), PASSWORD (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 CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY. To start the authentication flow with password verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value).
    
    For more information about SECRET_HASH, see Computing secret hash values. For information about DEVICE_KEY, see Working with user devices in your user pool.
  - setAuthParameters
```
public void setAuthParameters(java.util.Map<java.lang.String,java.lang.String> authParameters)
```
    The authentication parameters. These are inputs corresponding to the AuthFlow that you're 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 USER_PASSWORD_AUTH: USERNAME (required), PASSWORD (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 CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY. To start the authentication flow with password verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value).
    For more information about SECRET_HASH, see Computing secret hash values. For information about DEVICE_KEY, see Working with user devices in your user pool.
    Parameters:
    authParameters -
    The authentication parameters. These are inputs corresponding to the AuthFlow that you're 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 USER_PASSWORD_AUTH: USERNAME (required), PASSWORD (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 CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY. To start the authentication flow with password verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value).
    
    For more information about SECRET_HASH, see Computing secret hash values. For information about DEVICE_KEY, see Working with user devices in your user pool.
  - withAuthParameters
```
public InitiateAuthRequest withAuthParameters(java.util.Map<java.lang.String,java.lang.String> authParameters)
```
    The authentication parameters. These are inputs corresponding to the AuthFlow that you're 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 USER_PASSWORD_AUTH: USERNAME (required), PASSWORD (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 CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY. To start the authentication flow with password verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value).
    For more information about SECRET_HASH, see Computing secret hash values. For information about DEVICE_KEY, see Working with user devices in your user pool.
    
    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're 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 USER_PASSWORD_AUTH: USERNAME (required), PASSWORD (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 CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY. To start the authentication flow with password verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value).
    
    For more information about SECRET_HASH, see Computing secret hash values. For information about DEVICE_KEY, see Working with user devices in your user pool.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addAuthParametersEntry
```
public InitiateAuthRequest addAuthParametersEntry(java.lang.String key,
                                                  java.lang.String value)
```
    The authentication parameters. These are inputs corresponding to the AuthFlow that you're 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 USER_PASSWORD_AUTH: USERNAME (required), PASSWORD (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 CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY. To start the authentication flow with password verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value).
    For more information about SECRET_HASH, see Computing secret hash values. For information about DEVICE_KEY, see Working with user devices in your user pool.
    
    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 java.util.Map<java.lang.String,java.lang.String> getClientMetadata()
```
    A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.
    
    You create custom workflows by assigning Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:
    - Pre signup
    - Pre authentication
    - User migration
    When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a validationData attribute, which provides the data that you assigned to the ClientMetadata parameter in your InitiateAuth request. In your function code in Lambda, you can process the validationData value to enhance your workflow for your specific needs.
    
    When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:
    - Post authentication
    - Custom message
    - Pre token generation
    - Create auth challenge
    - Define auth challenge
    - Verify auth challenge
    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
    When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
    Returns:
    A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.
    
    You create custom workflows by assigning Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:
    
    Pre signup
    
    Pre authentication
    
    User migration
    
    When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a validationData attribute, which provides the data that you assigned to the ClientMetadata parameter in your InitiateAuth request. In your function code in Lambda, you can process the validationData value to enhance your workflow for your specific needs.
    
    When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:
    
    Post authentication
    
    Custom message
    
    Pre token generation
    
    Create auth challenge
    
    Define auth challenge
    
    Verify auth challenge
    
    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
    
    When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
  - setClientMetadata
```
public void setClientMetadata(java.util.Map<java.lang.String,java.lang.String> clientMetadata)
```
    A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.
    
    You create custom workflows by assigning Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:
    - Pre signup
    - Pre authentication
    - User migration
    When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a validationData attribute, which provides the data that you assigned to the ClientMetadata parameter in your InitiateAuth request. In your function code in Lambda, you can process the validationData value to enhance your workflow for your specific needs.
    
    When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:
    - Post authentication
    - Custom message
    - Pre token generation
    - Create auth challenge
    - Define auth challenge
    - Verify auth challenge
    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
    When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
    Parameters:
    clientMetadata -
    A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.
    
    You create custom workflows by assigning Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:
    
    Pre signup
    
    Pre authentication
    
    User migration
    
    When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a validationData attribute, which provides the data that you assigned to the ClientMetadata parameter in your InitiateAuth request. In your function code in Lambda, you can process the validationData value to enhance your workflow for your specific needs.
    
    When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:
    
    Post authentication
    
    Custom message
    
    Pre token generation
    
    Create auth challenge
    
    Define auth challenge
    
    Verify auth challenge
    
    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
    
    When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
  - withClientMetadata
```
public InitiateAuthRequest withClientMetadata(java.util.Map<java.lang.String,java.lang.String> clientMetadata)
```
    A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.
    
    You create custom workflows by assigning Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:
    - Pre signup
    - Pre authentication
    - User migration
    When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a validationData attribute, which provides the data that you assigned to the ClientMetadata parameter in your InitiateAuth request. In your function code in Lambda, you can process the validationData value to enhance your workflow for your specific needs.
    
    When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:
    - Post authentication
    - Custom message
    - Pre token generation
    - Create auth challenge
    - Define auth challenge
    - Verify auth challenge
    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
    When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
    Returns a reference to this object so that method calls can be chained together.
    Parameters:
    clientMetadata -
    A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.
    
    You create custom workflows by assigning Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:
    
    Pre signup
    
    Pre authentication
    
    User migration
    
    When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a validationData attribute, which provides the data that you assigned to the ClientMetadata parameter in your InitiateAuth request. In your function code in Lambda, you can process the validationData value to enhance your workflow for your specific needs.
    
    When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:
    
    Post authentication
    
    Custom message
    
    Pre token generation
    
    Create auth challenge
    
    Define auth challenge
    
    Verify auth challenge
    
    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
    
    When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addClientMetadataEntry
```
public InitiateAuthRequest addClientMetadataEntry(java.lang.String key,
                                                  java.lang.String value)
```
    A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.
    
    You create custom workflows by assigning Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:
    - Pre signup
    - Pre authentication
    - User migration
    When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a validationData attribute, which provides the data that you assigned to the ClientMetadata parameter in your InitiateAuth request. In your function code in Lambda, you can process the validationData value to enhance your workflow for your specific needs.
    
    When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:
    - Post authentication
    - Custom message
    - Pre token generation
    - Create auth challenge
    - Define auth challenge
    - Verify auth challenge
    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
    When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
    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 java.lang.String getClientId()
```
    The app client ID.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w+]+
    
    Returns:
    
    The app client ID.
  - setClientId
```
public void setClientId(java.lang.String clientId)
```
    The app client ID.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w+]+
    
    Parameters:
    
    clientId -
    The app client ID.
  - withClientId
```
public InitiateAuthRequest withClientId(java.lang.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.
  - getAnalyticsMetadata
```
public AnalyticsMetadataType getAnalyticsMetadata()
```
    The Amazon Pinpoint analytics metadata that contributes to your metrics for InitiateAuth calls.
    
    Returns:
    
    The Amazon Pinpoint analytics metadata that contributes to your metrics for InitiateAuth calls.
  - setAnalyticsMetadata
```
public void setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)
```
    The Amazon Pinpoint analytics metadata that contributes to your metrics for InitiateAuth calls.
    
    Parameters:
    
    analyticsMetadata -
    The Amazon Pinpoint analytics metadata that contributes to your metrics for InitiateAuth calls.
  - withAnalyticsMetadata
```
public InitiateAuthRequest withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)
```
    The Amazon Pinpoint analytics metadata that contributes to your metrics for InitiateAuth calls.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    analyticsMetadata -
    The Amazon Pinpoint analytics metadata that contributes to your metrics for InitiateAuth calls.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getUserContextData
```
public UserContextDataType getUserContextData()
```
    Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
    
    Returns:
    
    Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
  - setUserContextData
```
public void setUserContextData(UserContextDataType userContextData)
```
    Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
    
    Parameters:
    
    userContextData -
    Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
  - withUserContextData
```
public InitiateAuthRequest withUserContextData(UserContextDataType userContextData)
```
    Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    userContextData -
    Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class InitiateAuthRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

InitiateAuthRequest

Method Detail

getAuthFlow

setAuthFlow

withAuthFlow

setAuthFlow

withAuthFlow

getAuthParameters

setAuthParameters

withAuthParameters

addAuthParametersEntry

clearAuthParametersEntries

getClientMetadata

setClientMetadata

withClientMetadata

addClientMetadataEntry

clearClientMetadataEntries

getClientId

setClientId

withClientId

getAnalyticsMetadata

setAnalyticsMetadata

withAnalyticsMetadata

getUserContextData

setUserContextData

withUserContextData

toString

hashCode

equals