Serialized Form (AWS Java SDK for Amazon Cognito Identity Provider Service 1.12.754 API)

Package com.amazonaws.services.cognitoidp.model
- Class com.amazonaws.services.cognitoidp.model.AccountRecoverySettingType extends Object implements Serializable
  - Serialized Fields
    - recoveryMechanisms
```
List<E> recoveryMechanisms
```
      The list of RecoveryOptionTypes.
- Class com.amazonaws.services.cognitoidp.model.AccountTakeoverActionsType extends Object implements Serializable
  - Serialized Fields
    - lowAction
```
AccountTakeoverActionType lowAction
```
      Action to take for a low risk.
    - mediumAction
```
AccountTakeoverActionType mediumAction
```
      Action to take for a medium risk.
    - highAction
```
AccountTakeoverActionType highAction
```
      Action to take for a high risk.
- Class com.amazonaws.services.cognitoidp.model.AccountTakeoverActionType extends Object implements Serializable
  - Serialized Fields
    - notify
```
Boolean notify
```
      Flag specifying whether to send a notification.
    - eventAction
```
String eventAction
```
      The action to take in response to the account takeover action. Valid values are as follows:
      
      BLOCK Choosing this action will block the request.
      
      MFA_IF_CONFIGURED Present an MFA challenge if user has configured it, else allow the request.
      
      MFA_REQUIRED Present an MFA challenge if user has configured it, else block the request.
      
      NO_ACTION Allow the user to sign in.
- Class com.amazonaws.services.cognitoidp.model.AccountTakeoverRiskConfigurationType extends Object implements Serializable
  - Serialized Fields
    - notifyConfiguration
```
NotifyConfigurationType notifyConfiguration
```
      The notify configuration used to construct email notifications.
    - actions
```
AccountTakeoverActionsType actions
```
      Account takeover risk configuration actions.
- Class com.amazonaws.services.cognitoidp.model.AddCustomAttributesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool where you want to add custom attributes.
    - customAttributes
```
List<E> customAttributes
```
      An array of custom attributes, such as Mutable and Name.
- Class com.amazonaws.services.cognitoidp.model.AddCustomAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cognitoidp.model.AdminAddUserToGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool.
    - username
```
String username
```
      The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.
    - groupName
```
String groupName
```
      The name of the group that you want to add your user to.
- Class com.amazonaws.services.cognitoidp.model.AdminAddUserToGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cognitoidp.model.AdminConfirmSignUpRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for which you want to confirm user registration.
    - username
```
String username
```
      The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.
    - clientMetadata
```
Map<K,V> clientMetadata
```
      A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
      
      If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the Lambda function that is specified for the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the clientMetadata attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp request. In your function code in Lambda, you can process the ClientMetadata value to enhance your workflow for your specific needs.
      
      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.
- Class com.amazonaws.services.cognitoidp.model.AdminConfirmSignUpResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cognitoidp.model.AdminCreateUserConfigType extends Object implements Serializable
  - Serialized Fields
    - allowAdminCreateUserOnly
```
Boolean allowAdminCreateUserOnly
```
      Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.
    - unusedAccountValidityDays
```
Integer unusedAccountValidityDays
```
      The user account expiration limit, in days, after which a new account that hasn't signed in is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the MessageAction parameter. The default value for this parameter is 7.
      
      If you set a value for TemporaryPasswordValidityDays in PasswordPolicy, that value will be used, and UnusedAccountValidityDays will be no longer be an available parameter for that user pool.
    - inviteMessageTemplate
```
MessageTemplateType inviteMessageTemplate
```
      The message template to be used for the welcome message to new users.
      
      See also Customizing User Invitation Messages.
- Class com.amazonaws.services.cognitoidp.model.AdminCreateUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool where the user will be created.
    - username
```
String username
```
      The value that you want to set as the username sign-in attribute. The following conditions apply to the username parameter.
      
      The username can't be a duplicate of another username in the same user pool.
      
      You can't change the value of a username after you create it.
      
      You can only provide a value if usernames are a valid sign-in attribute for your user pool. If your user pool only supports phone numbers or email addresses as sign-in attributes, Amazon Cognito automatically generates a username value. For more information, see Customizing sign-in attributes.
    - userAttributes
```
List<E> userAttributes
```
      An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (when creating a user pool or in the Attributes tab of the console) either you should supply (in your call to AdminCreateUser) or the user should supply (when they sign up in response to your welcome message).
      
      For custom attributes, you must prepend the custom: prefix to the attribute name.
      
      To send a message inviting the user to sign up, you must specify the user's email address or phone number. You can do this in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
      
      In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. You can also do this by calling AdminUpdateUserAttributes.
      
      email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if "EMAIL" is specified in the DesiredDeliveryMediums parameter.
      
      phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if "SMS" is specified in the DesiredDeliveryMediums parameter.
    - validationData
```
List<E> validationData
```
      Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain.
      
      Your Lambda function can analyze this additional data and act on it. Your function might perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs. Validation data might also affect the response that your function returns to Amazon Cognito, like automatically confirming the user if they sign up from within your network.
      
      For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger.
    - temporaryPassword
```
String temporaryPassword
```
      The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.
      
      The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page, along with a new password to be used in all future sign-ins.
      
      This parameter isn't required. If you don't specify a value, Amazon Cognito generates one for you.
      
      The temporary password can only be used until the user account expiration limit that you set for your user pool. To reset the account after that time limit, you must call AdminCreateUser again and specify RESEND for the MessageAction parameter.
    - forceAliasCreation
```
Boolean forceAliasCreation
```
      This parameter is used only if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored.
      
      If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.
      
      If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.
    - messageAction
```
String messageAction
```
      Set to RESEND to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to SUPPRESS to suppress sending the message. You can specify only one value.
    - desiredDeliveryMediums
```
List<E> desiredDeliveryMediums
```
      Specify "EMAIL" if email will be used to send the welcome message. Specify "SMS" if the phone number will be used. The default value is "SMS". You can specify more than one value.
    - clientMetadata
```
Map<K,V> clientMetadata
```
      A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
      
      You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the pre sign-up trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
      
      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.
- Class com.amazonaws.services.cognitoidp.model.AdminCreateUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - user
```
UserType user
```
      The newly created user.
- Class com.amazonaws.services.cognitoidp.model.AdminDeleteUserAttributesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool where you want to delete user attributes.
    - username
```
String username
```
      The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.
    - userAttributeNames
```
List<E> userAttributeNames
```
      An array of strings representing the user attribute names you want to delete.
      
      For custom attributes, you must prepend the custom: prefix to the attribute name.
- Class com.amazonaws.services.cognitoidp.model.AdminDeleteUserAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cognitoidp.model.AdminDeleteUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool where you want to delete the user.
    - username
```
String username
```
      The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.
- Class com.amazonaws.services.cognitoidp.model.AdminDeleteUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cognitoidp.model.AdminDisableProviderForUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool.
    - user
```
ProviderUserIdentifierType user
```
      The user to be disabled.
- Class com.amazonaws.services.cognitoidp.model.AdminDisableProviderForUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cognitoidp.model.AdminDisableUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool where you want to disable the user.
    - username
```
String username
```
      The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.
- Class com.amazonaws.services.cognitoidp.model.AdminDisableUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cognitoidp.model.AdminEnableUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool where you want to enable the user.
    - username
```
String username
```
      The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.
- Class com.amazonaws.services.cognitoidp.model.AdminEnableUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cognitoidp.model.AdminForgetDeviceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID.
    - username
```
String username
```
      The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.
    - deviceKey
```
String deviceKey
```
      The device key.
- Class com.amazonaws.services.cognitoidp.model.AdminForgetDeviceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cognitoidp.model.AdminGetDeviceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - deviceKey
```
String deviceKey
```
      The device key.
    - userPoolId
```
String userPoolId
```
      The user pool ID.
    - username
```
String username
```
      The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.
- Class com.amazonaws.services.cognitoidp.model.AdminGetDeviceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - device
```
DeviceType device
```
      The device.
- Class com.amazonaws.services.cognitoidp.model.AdminGetUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool where you want to get information about the user.
    - username
```
String username
```
      The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.
- Class com.amazonaws.services.cognitoidp.model.AdminGetUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - username
```
String username
```
      The username of the user that you requested.
    - userAttributes
```
List<E> userAttributes
```
      An array of name-value pairs representing user attributes.
    - userCreateDate
```
Date userCreateDate
```
      The date the user was created.
    - userLastModifiedDate
```
Date userLastModifiedDate
```
      The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
    - enabled
```
Boolean enabled
```
      Indicates that the status is enabled.
    - userStatus
```
String userStatus
```
      The user status. Can be one of the following:
      
      UNCONFIRMED - User has been created but not confirmed.
      
      CONFIRMED - User has been confirmed.
      
      UNKNOWN - User status isn't known.
      
      RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
      
      FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
    - mFAOptions
```
List<E> mFAOptions
```
      This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.
    - preferredMfaSetting
```
String preferredMfaSetting
```
      The user's preferred MFA setting.
    - userMFASettingList
```
List<E> userMFASettingList
```
      The MFA options that are activated for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.
- Class com.amazonaws.services.cognitoidp.model.AdminInitiateAuthRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The ID of the Amazon Cognito user pool.
    - clientId
```
String clientId
```
      The app client ID.
    - authFlow
```
String authFlow
```
      The authentication flow for this call to run. 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 Secure Remote Password (SRP) protocol variables to be used for next challenge execution.
      
      ADMIN_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.
      
      ADMIN_USER_PASSWORD_AUTH: Admin-based user password authentication. This replaces the ADMIN_NO_SRP_AUTH authentication flow. In this flow, Amazon Cognito receives the password in the request instead of using the SRP process to verify passwords.
    - authParameters
```
Map<K,V> 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 ADMIN_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.
    - clientMetadata
```
Map<K,V> 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 AdminInitiateAuth 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 AdminInitiateAuth 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 AdminInitiateAuth 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
      
      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.
    - analyticsMetadata
```
AnalyticsMetadataType analyticsMetadata
```
      The analytics metadata for collecting Amazon Pinpoint metrics for AdminInitiateAuth calls.
    - contextData
```
ContextDataType contextData
```
      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.
- Class com.amazonaws.services.cognitoidp.model.AdminInitiateAuthResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - challengeName
```
String challengeName
```
      The name of the challenge that you're responding to with this call. This is returned in the AdminInitiateAuth response if you must pass another challenge.
      
      MFA_SETUP: If MFA is required, users who don't have at least one of the MFA methods set up are presented with an MFA_SETUP challenge. The user must set up at least one MFA type to continue to authenticate.
      
      SELECT_MFA_TYPE: Selects the MFA type. Valid MFA options are SMS_MFA for text SMS MFA, and SOFTWARE_TOKEN_MFA for time-based one-time password (TOTP) software token MFA.
      
      SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered via SMS.
      
      PASSWORD_VERIFIER: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side SRP calculations.
      
      CUSTOM_CHALLENGE: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.
      
      DEVICE_SRP_AUTH: If device tracking was activated in your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.
      
      DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, but for devices only.
      
      ADMIN_NO_SRP_AUTH: This is returned if you must authenticate with USERNAME and PASSWORD directly. An app client must be enabled to use this flow.
      
      NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful first login. Respond to this challenge with NEW_PASSWORD and any required attributes that Amazon Cognito returned in the requiredAttributes parameter. You can also set values for attributes that aren't required by your user pool and that your app client can write. For more information, see AdminRespondToAuthChallenge.
      
      In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. In AdminRespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the AdminUpdateUserAttributes API operation to modify the value of any additional attributes.
      
      MFA_SETUP: For users who are required to set up an MFA factor before they can sign in. The MFA types activated for the user pool will be listed in the challenge parameters MFAS_CAN_SETUP value.
      
      To set up software token MFA, use the session returned here from InitiateAuth as an input to AssociateSoftwareToken, and use the session returned by VerifySoftwareToken as an input to RespondToAuthChallenge with challenge name MFA_SETUP to complete sign-in. To set up SMS MFA, users will need help from an administrator to add a phone number to their account and then call InitiateAuth again to restart sign-in.
    - session
```
String session
```
      The session that should be passed both ways in challenge-response calls to the service. If AdminInitiateAuth or AdminRespondToAuthChallenge API call determines that the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next AdminRespondToAuthChallenge API call.
    - challengeParameters
```
Map<K,V> challengeParameters
```
      The challenge parameters. These are returned to you in the AdminInitiateAuth response if you must pass another challenge. The responses in this parameter should be used to compute inputs to the next call ( AdminRespondToAuthChallenge).
      
      All challenges require USERNAME and SECRET_HASH (if applicable).
      
      The value of the USER_ID_FOR_SRP attribute is the user's actual username, not an alias (such as email address or phone number), even if you specified an alias in your call to AdminInitiateAuth. This happens because, in the AdminRespondToAuthChallenge API ChallengeResponses, the USERNAME attribute can't be an alias.
    - authenticationResult
```
AuthenticationResultType authenticationResult
```
      The result of the authentication response. This is only returned if the caller doesn't need to pass another challenge. If the caller does need to pass another challenge before it gets tokens, ChallengeName, ChallengeParameters, and Session are returned.
- Class com.amazonaws.services.cognitoidp.model.AdminLinkProviderForUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool.
    - destinationUser
```
ProviderUserIdentifierType destinationUser
```
      The existing user in the user pool that you want to assign to the external IdP user account. This user can be a local (Username + Password) Amazon Cognito user pools user or a federated user (for example, a SAML or Facebook user). If the user doesn't exist, Amazon Cognito generates an exception. Amazon Cognito returns this user when the new user (with the linked IdP attribute) signs in.
      
      For a native username + password user, the ProviderAttributeValue for the DestinationUser should be the username in the user pool. For a federated user, it should be the provider-specific user_id.
      
      The ProviderAttributeName of the DestinationUser is ignored.
      
      The ProviderName should be set to Cognito for users in Cognito user pools.
      
      All attributes in the DestinationUser profile must be mutable. If you have assigned the user any immutable custom attributes, the operation won't succeed.
    - sourceUser
```
ProviderUserIdentifierType sourceUser
```
      An external IdP account for a user who doesn't exist yet in the user pool. This user must be a federated user (for example, a SAML or Facebook user), not another native user.
      
      If the SourceUser is using a federated social IdP, such as Facebook, Google, or Login with Amazon, you must set the ProviderAttributeName to Cognito_Subject. For social IdPs, the ProviderName will be Facebook, Google, or LoginWithAmazon, and Amazon Cognito will automatically parse the Facebook, Google, and Login with Amazon tokens for id, sub, and user_id, respectively. The ProviderAttributeValue for the user must be the same value as the id, sub, or user_id value found in the social IdP token.
      
      For OIDC, the ProviderAttributeName can be any value that matches a claim in the ID token, or that your app retrieves from the userInfo endpoint. You must map the claim to a user pool attribute in your IdP configuration, and set the user pool attribute name as the value of ProviderAttributeName in your AdminLinkProviderForUser request.
      
      For SAML, the ProviderAttributeName can be any value that matches a claim in the SAML assertion. To link SAML users based on the subject of the SAML assertion, map the subject to a claim through the SAML IdP and set that claim name as the value of ProviderAttributeName in your AdminLinkProviderForUser request.
      
      For both OIDC and SAML users, when you set ProviderAttributeName to Cognito_Subject, Amazon Cognito will automatically parse the default unique identifier found in the subject from the IdP token.
- Class com.amazonaws.services.cognitoidp.model.AdminLinkProviderForUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cognitoidp.model.AdminListDevicesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID.
    - username
```
String username
```
      The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.
    - limit
```
Integer limit
```
      The limit of the devices request.
    - paginationToken
```
String paginationToken
```
      This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.
- Class com.amazonaws.services.cognitoidp.model.AdminListDevicesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - devices
```
List<E> devices
```
      The devices in the list of devices response.
    - paginationToken
```
String paginationToken
```
      The identifier that Amazon Cognito returned with the previous request to this operation. When you include a pagination token in your request, Amazon Cognito returns the next set of items in the list. By use of this token, you can paginate through the full list of items.
- Class com.amazonaws.services.cognitoidp.model.AdminListGroupsForUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - username
```
String username
```
      The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool.
    - limit
```
Integer limit
```
      The limit of the request to list groups.
    - nextToken
```
String nextToken
```
      An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
- Class com.amazonaws.services.cognitoidp.model.AdminListGroupsForUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - groups
```
List<E> groups
```
      The groups that the user belongs to.
    - nextToken
```
String nextToken
```
      An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
- Class com.amazonaws.services.cognitoidp.model.AdminListUserAuthEventsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID.
    - username
```
String username
```
      The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.
    - maxResults
```
Integer maxResults
```
      The maximum number of authentication events to return. Returns 60 events if you set MaxResults to 0, or if you don't include a MaxResults parameter.
    - nextToken
```
String nextToken
```
      A pagination token.
- Class com.amazonaws.services.cognitoidp.model.AdminListUserAuthEventsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - authEvents
```
List<E> authEvents
```
      The response object. It includes the EventID, EventType, CreationDate, EventRisk, and EventResponse.
    - nextToken
```
String nextToken
```
      A pagination token.
- Class com.amazonaws.services.cognitoidp.model.AdminRemoveUserFromGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool.
    - username
```
String username
```
      The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.
    - groupName
```
String groupName
```
      The group name.
- Class com.amazonaws.services.cognitoidp.model.AdminRemoveUserFromGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cognitoidp.model.AdminResetUserPasswordRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool where you want to reset the user's password.
    - username
```
String username
```
      The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.
    - clientMetadata
```
Map<K,V> clientMetadata
```
      A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
      
      You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
      
      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.
- Class com.amazonaws.services.cognitoidp.model.AdminResetUserPasswordResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cognitoidp.model.AdminRespondToAuthChallengeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The ID of the Amazon Cognito user pool.
    - clientId
```
String clientId
```
      The app client ID.
    - challengeName
```
String challengeName
```
      The challenge name. For more information, see AdminInitiateAuth.
    - challengeResponses
```
Map<K,V> challengeResponses
```
      The responses to the challenge that you received in the previous request. Each challenge has its own required response parameters. The following examples are partial JSON request bodies that highlight challenge-response parameters.
      
      You must provide a SECRET_HASH parameter in all challenge responses to an app client that has a client secret.
      
      SMS_MFA
      
      "ChallengeName": "SMS_MFA", "ChallengeResponses": {"SMS_MFA_CODE": "[SMS_code]", "USERNAME": "[username]"}
      
      PASSWORD_VERIFIER
      
      "ChallengeName": "PASSWORD_VERIFIER", "ChallengeResponses": {"PASSWORD_CLAIM_SIGNATURE": "[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP": [timestamp], "USERNAME": "[username]"}
      
      Add "DEVICE_KEY" when you sign in with a remembered device.
      
      CUSTOM_CHALLENGE
      
      "ChallengeName": "CUSTOM_CHALLENGE", "ChallengeResponses": {"USERNAME": "[username]", "ANSWER": "[challenge_answer]"}
      
      Add "DEVICE_KEY" when you sign in with a remembered device.
      
      NEW_PASSWORD_REQUIRED
      
      "ChallengeName": "NEW_PASSWORD_REQUIRED", "ChallengeResponses": {"NEW_PASSWORD": "[new_password]", "USERNAME": "[username]"}
      
      To set any required attributes that InitiateAuth returned in an requiredAttributes parameter, add "userAttributes.[attribute_name]": "[attribute_value]". This parameter can also set values for writable attributes that aren't required by your user pool.
      
      In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. In RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the UpdateUserAttributes API operation to modify the value of any additional attributes.
      
      SOFTWARE_TOKEN_MFA
      
      "ChallengeName": "SOFTWARE_TOKEN_MFA", "ChallengeResponses": {"USERNAME": "[username]", "SOFTWARE_TOKEN_MFA_CODE": [authenticator_code]}
      
      DEVICE_SRP_AUTH
      
      "ChallengeName": "DEVICE_SRP_AUTH", "ChallengeResponses": {"USERNAME": "[username]", "DEVICE_KEY": "[device_key]", "SRP_A": "[srp_a]"}
      
      DEVICE_PASSWORD_VERIFIER
      
      "ChallengeName": "DEVICE_PASSWORD_VERIFIER", "ChallengeResponses": {"DEVICE_KEY": "[device_key]", "PASSWORD_CLAIM_SIGNATURE": "[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP": [timestamp], "USERNAME": "[username]"}
      
      MFA_SETUP
      
      "ChallengeName": "MFA_SETUP", "ChallengeResponses": {"USERNAME": "[username]"}, "SESSION": "[Session ID from VerifySoftwareToken]"
      
      SELECT_MFA_TYPE
      
      "ChallengeName": "SELECT_MFA_TYPE", "ChallengeResponses": {"USERNAME": "[username]", "ANSWER": "[SMS_MFA or SOFTWARE_TOKEN_MFA]"}
      
      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.
    - session
```
String session
```
      The session that should be passed both ways in challenge-response calls to the service. If an InitiateAuth or RespondToAuthChallenge API call determines that the caller must pass another challenge, it returns a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
    - analyticsMetadata
```
AnalyticsMetadataType analyticsMetadata
```
      The analytics metadata for collecting Amazon Pinpoint metrics for AdminRespondToAuthChallenge calls.
    - contextData
```
ContextDataType contextData
```
      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.
    - clientMetadata
```
Map<K,V> clientMetadata
```
      A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
      
      You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that you have assigned to the following triggers:
      
      pre sign-up
      
      custom message
      
      post authentication
      
      user migration
      
      pre token generation
      
      define auth challenge
      
      create auth challenge
      
      verify auth challenge response
      
      When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute that provides the data that you assigned to the ClientMetadata parameter in your AdminRespondToAuthChallenge request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
      
      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.
- Class com.amazonaws.services.cognitoidp.model.AdminRespondToAuthChallengeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - challengeName
```
String challengeName
```
      The name of the challenge. For more information, see AdminInitiateAuth.
    - session
```
String session
```
      The session that should be passed both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
    - challengeParameters
```
Map<K,V> challengeParameters
```
      The challenge parameters. For more information, see AdminInitiateAuth.
    - authenticationResult
```
AuthenticationResultType authenticationResult
```
      The result returned by the server in response to the authentication request.
- Class com.amazonaws.services.cognitoidp.model.AdminSetUserMFAPreferenceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - sMSMfaSettings
```
SMSMfaSettingsType sMSMfaSettings
```
      The SMS text message MFA settings.
    - softwareTokenMfaSettings
```
SoftwareTokenMfaSettingsType softwareTokenMfaSettings
```
      The time-based one-time password software token MFA settings.
    - username
```
String username
```
      The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.
    - userPoolId
```
String userPoolId
```
      The user pool ID.
- Class com.amazonaws.services.cognitoidp.model.AdminSetUserMFAPreferenceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cognitoidp.model.AdminSetUserPasswordRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool where you want to set the user's password.
    - username
```
String username
```
      The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.
    - password
```
String password
```
      The password for the user.
    - permanent
```
Boolean permanent
```
      True if the password is permanent, False if it is temporary.
- Class com.amazonaws.services.cognitoidp.model.AdminSetUserPasswordResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cognitoidp.model.AdminSetUserSettingsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The ID of the user pool that contains the user whose options you're setting.
    - username
```
String username
```
      The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.
    - mFAOptions
```
List<E> mFAOptions
```
      You can use this parameter only to set an SMS configuration that uses SMS for delivery.
- Class com.amazonaws.services.cognitoidp.model.AdminSetUserSettingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cognitoidp.model.AdminUpdateAuthEventFeedbackRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID.
    - username
```
String username
```
      The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.
    - eventId
```
String eventId
```
      The authentication event ID.
    - feedbackValue
```
String feedbackValue
```
      The authentication event feedback value. When you provide a FeedbackValue value of valid, you tell Amazon Cognito that you trust a user session where Amazon Cognito has evaluated some level of risk. When you provide a FeedbackValue value of invalid, you tell Amazon Cognito that you don't trust a user session, or you don't believe that Amazon Cognito evaluated a high-enough risk level.
- Class com.amazonaws.services.cognitoidp.model.AdminUpdateAuthEventFeedbackResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cognitoidp.model.AdminUpdateDeviceStatusRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID.
    - username
```
String username
```
      The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.
    - deviceKey
```
String deviceKey
```
      The device key.
    - deviceRememberedStatus
```
String deviceRememberedStatus
```
      The status indicating whether a device has been remembered or not.
- Class com.amazonaws.services.cognitoidp.model.AdminUpdateDeviceStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cognitoidp.model.AdminUpdateUserAttributesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool where you want to update user attributes.
    - username
```
String username
```
      The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.
    - userAttributes
```
List<E> userAttributes
```
      An array of name-value pairs representing user attributes.
      
      For custom attributes, you must prepend the custom: prefix to the attribute name.
      
      If your user pool requires verification before Amazon Cognito updates an attribute value that you specify in this request, Amazon Cognito doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value.
      
      To update the value of an attribute that requires verification in the same API request, include the email_verified or phone_number_verified attribute, with a value of true. If you set the email_verified or phone_number_verified value for an email or phone_number attribute that requires verification to true, Amazon Cognito doesn’t send a verification message to your user.
    - clientMetadata
```
Map<K,V> clientMetadata
```
      A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
      
      You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminUpdateUserAttributes request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
      
      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.
- Class com.amazonaws.services.cognitoidp.model.AdminUpdateUserAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cognitoidp.model.AdminUserGlobalSignOutRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID.
    - username
```
String username
```
      The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.
- Class com.amazonaws.services.cognitoidp.model.AdminUserGlobalSignOutResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cognitoidp.model.AliasExistsException extends AWSCognitoIdentityProviderException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidp.model.AnalyticsConfigurationType extends Object implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The application ID for an Amazon Pinpoint application.
    - applicationArn
```
String applicationArn
```
      The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project to integrate with the chosen user pool Client. Amazon Cognito publishes events to the Amazon Pinpoint project that the app ARN declares.
    - roleArn
```
String roleArn
```
      The ARN of an Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.
    - externalId
```
String externalId
```
      The external ID.
    - userDataShared
```
Boolean userDataShared
```
      If UserDataShared is true, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.
- Class com.amazonaws.services.cognitoidp.model.AnalyticsMetadataType extends Object implements Serializable
  - Serialized Fields
    - analyticsEndpointId
```
String analyticsEndpointId
```
      The endpoint ID.
- Class com.amazonaws.services.cognitoidp.model.AssociateSoftwareTokenRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accessToken
```
String accessToken
```
      A valid access token that Amazon Cognito issued to the user whose software token you want to generate.
    - session
```
String session
```
      The session that should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process.
- Class com.amazonaws.services.cognitoidp.model.AssociateSoftwareTokenResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - secretCode
```
String secretCode
```
      A unique generated shared secret code that is used in the TOTP algorithm to generate a one-time code.
    - session
```
String session
```
      The session that should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process.
- Class com.amazonaws.services.cognitoidp.model.AttributeType extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the attribute.
    - value
```
String value
```
      The value of the attribute.
- Class com.amazonaws.services.cognitoidp.model.AuthenticationResultType extends Object implements Serializable
  - Serialized Fields
    - accessToken
```
String accessToken
```
      A valid access token that Amazon Cognito issued to the user who you want to authenticate.
    - expiresIn
```
Integer expiresIn
```
      The expiration period of the authentication result in seconds.
    - tokenType
```
String tokenType
```
      The token type.
    - refreshToken
```
String refreshToken
```
      The refresh token.
    - idToken
```
String idToken
```
      The ID token.
    - newDeviceMetadata
```
NewDeviceMetadataType newDeviceMetadata
```
      The new device metadata from an authentication result.
- Class com.amazonaws.services.cognitoidp.model.AuthEventType extends Object implements Serializable
  - Serialized Fields
    - eventId
```
String eventId
```
      The event ID.
    - eventType
```
String eventType
```
      The event type.
    - creationDate
```
Date creationDate
```
      The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
    - eventResponse
```
String eventResponse
```
      The event response.
    - eventRisk
```
EventRiskType eventRisk
```
      The event risk.
    - challengeResponses
```
List<E> challengeResponses
```
      The challenge responses.
    - eventContextData
```
EventContextDataType eventContextData
```
      The user context data captured at the time of an event request. This value provides additional information about the client from which event the request is received.
    - eventFeedback
```
EventFeedbackType eventFeedback
```
      A flag specifying the user feedback captured at the time of an event request is good or bad.
- Class com.amazonaws.services.cognitoidp.model.AWSCognitoIdentityProviderException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidp.model.ChallengeResponseType extends Object implements Serializable
  - Serialized Fields
    - challengeName
```
String challengeName
```
      The challenge name.
    - challengeResponse
```
String challengeResponse
```
      The challenge response.
- Class com.amazonaws.services.cognitoidp.model.ChangePasswordRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - previousPassword
```
String previousPassword
```
      The old password.
    - proposedPassword
```
String proposedPassword
```
      The new password.
    - accessToken
```
String accessToken
```
      A valid access token that Amazon Cognito issued to the user whose password you want to change.
- Class com.amazonaws.services.cognitoidp.model.ChangePasswordResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cognitoidp.model.CloudWatchLogsConfigurationType extends Object implements Serializable
  - Serialized Fields
    - logGroupArn
```
String logGroupArn
```
      The Amazon Resource Name (arn) of a CloudWatch Logs log group where your user pool sends logs. The log group must not be encrypted with Key Management Service and must be in the same Amazon Web Services account as your user pool.
      
      To send logs to log groups with a resource policy of a size greater than 5120 characters, configure a log group with a path that starts with /aws/vendedlogs. For more information, see Enabling logging from certain Amazon Web Services services.
- Class com.amazonaws.services.cognitoidp.model.CodeDeliveryDetailsType extends Object implements Serializable
  - Serialized Fields
    - destination
```
String destination
```
      The email address or phone number destination where Amazon Cognito sent the code.
    - deliveryMedium
```
String deliveryMedium
```
      The method that Amazon Cognito used to send the code.
    - attributeName
```
String attributeName
```
      The name of the attribute that Amazon Cognito verifies with the code.
- Class com.amazonaws.services.cognitoidp.model.CodeDeliveryFailureException extends AWSCognitoIdentityProviderException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidp.model.CodeMismatchException extends AWSCognitoIdentityProviderException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidp.model.CompromisedCredentialsActionsType extends Object implements Serializable
  - Serialized Fields
    - eventAction
```
String eventAction
```
      The event action.
- Class com.amazonaws.services.cognitoidp.model.CompromisedCredentialsRiskConfigurationType extends Object implements Serializable
  - Serialized Fields
    - eventFilter
```
List<E> eventFilter
```
      Perform the action for these events. The default is to perform all events if no event filter is specified.
    - actions
```
CompromisedCredentialsActionsType actions
```
      The compromised credentials risk configuration actions.
- Class com.amazonaws.services.cognitoidp.model.ConcurrentModificationException extends AWSCognitoIdentityProviderException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidp.model.ConfirmDeviceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accessToken
```
String accessToken
```
      A valid access token that Amazon Cognito issued to the user whose device you want to confirm.
    - deviceKey
```
String deviceKey
```
      The device key.
    - deviceSecretVerifierConfig
```
DeviceSecretVerifierConfigType deviceSecretVerifierConfig
```
      The configuration of the device secret verifier.
    - deviceName
```
String deviceName
```
      The device name.
- Class com.amazonaws.services.cognitoidp.model.ConfirmDeviceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - userConfirmationNecessary
```
Boolean userConfirmationNecessary
```
      Indicates whether the user confirmation must confirm the device response.
- Class com.amazonaws.services.cognitoidp.model.ConfirmForgotPasswordRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientId
```
String clientId
```
      The app client ID of the app associated with the user pool.
    - secretHash
```
String secretHash
```
      A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message. For more information about SecretHash, see Computing secret hash values.
    - username
```
String username
```
      The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.
    - confirmationCode
```
String confirmationCode
```
      The confirmation code from your user's request to reset their password. For more information, see ForgotPassword.
    - password
```
String password
```
      The new password that your user wants to set.
    - analyticsMetadata
```
AnalyticsMetadataType analyticsMetadata
```
      The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.
    - userContextData
```
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.
    - clientMetadata
```
Map<K,V> clientMetadata
```
      A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
      
      You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmForgotPassword API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmForgotPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
      
      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.
- Class com.amazonaws.services.cognitoidp.model.ConfirmForgotPasswordResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cognitoidp.model.ConfirmSignUpRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientId
```
String clientId
```
      The ID of the app client associated with the user pool.
    - secretHash
```
String secretHash
```
      A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
    - username
```
String username
```
      The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.
    - confirmationCode
```
String confirmationCode
```
      The confirmation code sent by a user's request to confirm registration.
    - forceAliasCreation
```
Boolean forceAliasCreation
```
      Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.
    - analyticsMetadata
```
AnalyticsMetadataType analyticsMetadata
```
      The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.
    - userContextData
```
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.
    - clientMetadata
```
Map<K,V> clientMetadata
```
      A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
      
      You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
      
      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.
- Class com.amazonaws.services.cognitoidp.model.ConfirmSignUpResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cognitoidp.model.ContextDataType extends Object implements Serializable
  - Serialized Fields
    - ipAddress
```
String ipAddress
```
      The source IP address of your user's device.
    - serverName
```
String serverName
```
      Your server endpoint where this API is invoked.
    - serverPath
```
String serverPath
```
      Your server path where this API is invoked.
    - httpHeaders
```
List<E> httpHeaders
```
      HttpHeaders received on your server in same order.
    - encodedData
```
String encodedData
```
      Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests.
- Class com.amazonaws.services.cognitoidp.model.CreateGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - groupName
```
String groupName
```
      The name of the group. Must be unique.
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool.
    - description
```
String description
```
      A string containing the description of the group.
    - roleArn
```
String roleArn
```
      The role Amazon Resource Name (ARN) for the group.
    - precedence
```
Integer precedence
```
      A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the cognito:roles and cognito:preferred_role claims.
      
      Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim isn't set in users' tokens.
      
      The default Precedence value is null. The maximum Precedence value is 2^31-1.
- Class com.amazonaws.services.cognitoidp.model.CreateGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - group
```
GroupType group
```
      The group object for the group.
- Class com.amazonaws.services.cognitoidp.model.CreateIdentityProviderRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID.
    - providerName
```
String providerName
```
      The IdP name.
    - providerType
```
String providerType
```
      The IdP type.
    - providerDetails
```
Map<K,V> providerDetails
```
      The scopes, URLs, and identifiers for your external identity provider. The following examples describe the provider detail keys for each IdP type. These values and their schema are subject to change. Social IdP authorize_scopes values must match the values listed here.
      
      OpenID Connect (OIDC)
      
      Amazon Cognito accepts the following elements when it can't discover endpoint URLs from oidc_issuer: attributes_url, authorize_url, jwks_uri, token_url.
      
      Create or update request: "ProviderDetails": { "attributes_request_method": "GET", "attributes_url": "https://auth.example.com/userInfo", "authorize_scopes": "openid profile email", "authorize_url": "https://auth.example.com/authorize", "client_id": "1example23456789", "client_secret": "provider-app-client-secret", "jwks_uri": "https://auth.example.com/.well-known/jwks.json", "oidc_issuer": "https://auth.example.com", "token_url": "https://example.com/token" }
      
      Describe response: "ProviderDetails": { "attributes_request_method": "GET", "attributes_url": "https://auth.example.com/userInfo", "attributes_url_add_attributes": "false", "authorize_scopes": "openid profile email", "authorize_url": "https://auth.example.com/authorize", "client_id": "1example23456789", "client_secret": "provider-app-client-secret", "jwks_uri": "https://auth.example.com/.well-known/jwks.json", "oidc_issuer": "https://auth.example.com", "token_url": "https://example.com/token" }
      
      SAML
      
      Create or update request with Metadata URL: "ProviderDetails": { "IDPInit": "true", "IDPSignout": "true", "EncryptedResponses" : "true", "MetadataURL": "https://auth.example.com/sso/saml/metadata", "RequestSigningAlgorithm": "rsa-sha256" }
      
      Create or update request with Metadata file: "ProviderDetails": { "IDPInit": "true", "IDPSignout": "true", "EncryptedResponses" : "true", "MetadataFile": "[metadata XML]", "RequestSigningAlgorithm": "rsa-sha256" }
      
      The value of MetadataFile must be the plaintext metadata document with all quote (") characters escaped by backslashes.
      
      Describe response: "ProviderDetails": { "IDPInit": "true", "IDPSignout": "true", "EncryptedResponses" : "true", "ActiveEncryptionCertificate": "[certificate]", "MetadataURL": "https://auth.example.com/sso/saml/metadata", "RequestSigningAlgorithm": "rsa-sha256", "SLORedirectBindingURI": "https://auth.example.com/slo/saml", "SSORedirectBindingURI": "https://auth.example.com/sso/saml" }
      
      LoginWithAmazon
      
      Create or update request: "ProviderDetails": { "authorize_scopes": "profile postal_code", "client_id": "amzn1.application-oa2-client.1example23456789", "client_secret": "provider-app-client-secret"
      
      Describe response: "ProviderDetails": { "attributes_url": "https://api.amazon.com/user/profile", "attributes_url_add_attributes": "false", "authorize_scopes": "profile postal_code", "authorize_url": "https://www.amazon.com/ap/oa", "client_id": "amzn1.application-oa2-client.1example23456789", "client_secret": "provider-app-client-secret", "token_request_method": "POST", "token_url": "https://api.amazon.com/auth/o2/token" }
      
      Google
      
      Create or update request: "ProviderDetails": { "authorize_scopes": "email profile openid", "client_id": "1example23456789.apps.googleusercontent.com", "client_secret": "provider-app-client-secret" }
      
      Describe response: "ProviderDetails": { "attributes_url": "https://people.googleapis.com/v1/people/me?personFields=", "attributes_url_add_attributes": "true", "authorize_scopes": "email profile openid", "authorize_url": "https://accounts.google.com/o/oauth2/v2/auth", "client_id": "1example23456789.apps.googleusercontent.com", "client_secret": "provider-app-client-secret", "oidc_issuer": "https://accounts.google.com", "token_request_method": "POST", "token_url": "https://www.googleapis.com/oauth2/v4/token" }
      
      SignInWithApple
      
      Create or update request: "ProviderDetails": { "authorize_scopes": "email name", "client_id": "com.example.cognito", "private_key": "1EXAMPLE", "key_id": "2EXAMPLE", "team_id": "3EXAMPLE" }
      
      Describe response: "ProviderDetails": { "attributes_url_add_attributes": "false", "authorize_scopes": "email name", "authorize_url": "https://appleid.apple.com/auth/authorize", "client_id": "com.example.cognito", "key_id": "1EXAMPLE", "oidc_issuer": "https://appleid.apple.com", "team_id": "2EXAMPLE", "token_request_method": "POST", "token_url": "https://appleid.apple.com/auth/token" }
      
      Facebook
      
      Create or update request: "ProviderDetails": { "api_version": "v17.0", "authorize_scopes": "public_profile, email", "client_id": "1example23456789", "client_secret": "provider-app-client-secret" }
      
      Describe response: "ProviderDetails": { "api_version": "v17.0", "attributes_url": "https://graph.facebook.com/v17.0/me?fields=", "attributes_url_add_attributes": "true", "authorize_scopes": "public_profile, email", "authorize_url": "https://www.facebook.com/v17.0/dialog/oauth", "client_id": "1example23456789", "client_secret": "provider-app-client-secret", "token_request_method": "GET", "token_url": "https://graph.facebook.com/v17.0/oauth/access_token" }
    - attributeMapping
```
Map<K,V> attributeMapping
```
      A mapping of IdP attributes to standard and custom user pool attributes.
    - idpIdentifiers
```
List<E> idpIdentifiers
```
      A list of IdP identifiers.
- Class com.amazonaws.services.cognitoidp.model.CreateIdentityProviderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - identityProvider
```
IdentityProviderType identityProvider
```
      The newly created IdP object.
- Class com.amazonaws.services.cognitoidp.model.CreateResourceServerRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool.
    - identifier
```
String identifier
```
      A unique resource server identifier for the resource server. The identifier can be an API friendly name like solar-system-data. You can also set an API URL like https://solar-system-data-api.example.com as your identifier.
      
      Amazon Cognito represents scopes in the access token in the format $resource-server-identifier/$scope. Longer scope-identifier strings increase the size of your access tokens.
    - name
```
String name
```
      A friendly name for the resource server.
    - scopes
```
List<E> scopes
```
      A list of scopes. Each scope is a key-value map with the keys name and description.
- Class com.amazonaws.services.cognitoidp.model.CreateResourceServerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - resourceServer
```
ResourceServerType resourceServer
```
      The newly created resource server.
- Class com.amazonaws.services.cognitoidp.model.CreateUserImportJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobName
```
String jobName
```
      The job name for the user import job.
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool that the users are being imported into.
    - cloudWatchLogsRoleArn
```
String cloudWatchLogsRoleArn
```
      The role ARN for the Amazon CloudWatch Logs Logging role for the user import job.
- Class com.amazonaws.services.cognitoidp.model.CreateUserImportJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - userImportJob
```
UserImportJobType userImportJob
```
      The job object that represents the user import job.
- Class com.amazonaws.services.cognitoidp.model.CreateUserPoolClientRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool where you want to create a user pool client.
    - clientName
```
String clientName
```
      The client name for the user pool client you would like to create.
    - generateSecret
```
Boolean generateSecret
```
      Boolean to specify whether you want to generate a secret for the user pool client being created.
    - refreshTokenValidity
```
Integer refreshTokenValidity
```
      The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the time unit for RefreshTokenValidity as seconds, minutes, hours , or days, set a TokenValidityUnits value in your API request.
      
      For example, when you set RefreshTokenValidity as 10 and TokenValidityUnits as days, your user can refresh their session and retrieve new access and ID tokens for 10 days.
      
      The default time unit for RefreshTokenValidity in an API request is days. You can't set RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. Valid range is displayed below in seconds.
      
      If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
    - accessTokenValidity
```
Integer accessTokenValidity
```
      The access token time limit. After this limit expires, your user can't use their access token. To specify the time unit for AccessTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.
      
      For example, when you set AccessTokenValidity to 10 and TokenValidityUnits to hours, your user can authorize access with their access token for 10 hours.
      
      The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.
      
      If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.
    - idTokenValidity
```
Integer idTokenValidity
```
      The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for IdTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.
      
      For example, when you set IdTokenValidity as 10 and TokenValidityUnits as hours, your user can authenticate their session with their ID token for 10 hours.
      
      The default time unit for IdTokenValidity in an API request is hours. Valid range is displayed below in seconds.
      
      If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
    - tokenValidityUnits
```
TokenValidityUnitsType tokenValidityUnits
```
      The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours.
    - readAttributes
```
List<E> readAttributes
```
      The list of user attributes that you want your app client to have read-only access to. After your user authenticates in your app, their access token authorizes them to read their own attribute value for any attribute in this list. An example of this kind of activity is when your user selects a link to view their profile information. Your app makes a GetUser API request to retrieve and display your user's profile data.
      
      When you don't specify the ReadAttributes for your app client, your app can read the values of email_verified, phone_number_verified, and the Standard attributes of your user pool. When your user pool has read access to these default attributes, ReadAttributes doesn't return any information. Amazon Cognito only populates ReadAttributes in the API response if you have specified your own custom set of read attributes.
    - writeAttributes
```
List<E> writeAttributes
```
      The list of user attributes that you want your app client to have write access to. After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list. An example of this kind of activity is when you present your user with a form to update their profile information and they change their last name. Your app then makes an UpdateUserAttributes API request and sets family_name to the new value.
      
      When you don't specify the WriteAttributes for your app client, your app can write the values of the Standard attributes of your user pool. When your user pool has write access to these default attributes, WriteAttributes doesn't return any information. Amazon Cognito only populates WriteAttributes in the API response if you have specified your own custom set of write attributes.
      
      If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool.
    - explicitAuthFlows
```
List<E> explicitAuthFlows
```
      The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
      
      If you don't specify a value for ExplicitAuthFlows, your user client supports ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.
      
      Valid values include:
      
      ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.
      
      ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
      
      ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
      
      ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
      
      ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
      
      In some environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or USER_PASSWORD_AUTH. You can't assign these legacy ExplicitAuthFlows values to user pool clients at the same time as values that begin with ALLOW_, like ALLOW_USER_SRP_AUTH.
    - supportedIdentityProviders
```
List<E> supportedIdentityProviders
```
      A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: COGNITO, Facebook, Google, SignInWithApple, and LoginWithAmazon. You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example MySAMLIdP or MyOIDCIdP.
    - callbackURLs
```
List<E> callbackURLs
```
      A list of allowed redirect (callback) URLs for the IdPs.
      
      A redirect URI must:
      
      Be an absolute URI.
      
      Be registered with the authorization server.
      
      Not include a fragment component.
      
      See OAuth 2.0 - Redirection Endpoint.
      
      Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
      
      App callback URLs such as myapp://example are also supported.
    - logoutURLs
```
List<E> logoutURLs
```
      A list of allowed logout URLs for the IdPs.
    - defaultRedirectURI
```
String defaultRedirectURI
```
      The default redirect URI. In app clients with one assigned IdP, replaces redirect_uri in authentication requests. Must be in the CallbackURLs list.
      
      A redirect URI must:
      
      Be an absolute URI.
      
      Be registered with the authorization server.
      
      Not include a fragment component.
      
      For more information, see Default redirect URI.
      
      Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
      
      App callback URLs such as myapp://example are also supported.
    - allowedOAuthFlows
```
List<E> allowedOAuthFlows
```
      The OAuth grant types that you want your app client to generate. To create an app client that generates client credentials grants, you must add client_credentials as the only allowed OAuth flow.
      
      code
      
      Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the /oauth2/token endpoint.
      
      implicit
      
      Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
      
      client_credentials
      
      Issue the access token from the /oauth2/token endpoint directly to a non-person user using a combination of the client ID and client secret.
    - allowedOAuthScopes
```
List<E> allowedOAuthScopes
```
      The allowed OAuth scopes. Possible values provided by OAuth are phone, email, openid, and profile. Possible values provided by Amazon Web Services are aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
    - allowedOAuthFlowsUserPoolClient
```
Boolean allowedOAuthFlowsUserPoolClient
```
      Set to true to use OAuth 2.0 features in your user pool app client.
      
      AllowedOAuthFlowsUserPoolClient must be true before you can configure the following features in your app client.
      
      CallBackURLs: Callback URLs.
      
      LogoutURLs: Sign-out redirect URLs.
      
      AllowedOAuthScopes: OAuth 2.0 scopes.
      
      AllowedOAuthFlows: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.
      
      To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set AllowedOAuthFlowsUserPoolClient to true in a CreateUserPoolClient or UpdateUserPoolClient API request. If you don't set a value for AllowedOAuthFlowsUserPoolClient in a request with the CLI or SDKs, it defaults to false .
    - analyticsConfiguration
```
AnalyticsConfigurationType analyticsConfiguration
```
      The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
      
      In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
    - preventUserExistenceErrors
```
String preventUserExistenceErrors
```
      Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to ENABLED and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn't exist in the user pool.
      
      Valid values include:
      
      ENABLED - This prevents user existence-related errors.
      
      LEGACY - This represents the early behavior of Amazon Cognito where user existence related errors aren't prevented.
    - enableTokenRevocation
```
Boolean enableTokenRevocation
```
      Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
      
      If you don't include this parameter, token revocation is automatically activated for the new user pool client.
    - enablePropagateAdditionalUserContextData
```
Boolean enablePropagateAdditionalUserContextData
```
      Activates the propagation of additional user context data. For more information about propagation of user context data, see Adding advanced security to a user pool. If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret.
    - authSessionValidity
```
Integer authSessionValidity
```
      Amazon Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.
- Class com.amazonaws.services.cognitoidp.model.CreateUserPoolClientResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - userPoolClient
```
UserPoolClientType userPoolClient
```
      The user pool client that was just created.
- Class com.amazonaws.services.cognitoidp.model.CreateUserPoolDomainRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domain
```
String domain
```
      The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.
    - userPoolId
```
String userPoolId
```
      The user pool ID.
    - customDomainConfig
```
CustomDomainConfigType customDomainConfig
```
      The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
      
      Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead.
      
      For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.
- Class com.amazonaws.services.cognitoidp.model.CreateUserPoolDomainResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - cloudFrontDomain
```
String cloudFrontDomain
```
      The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider. Amazon Cognito returns this value if you set a custom domain with CustomDomainConfig. If you set an Amazon Cognito prefix domain, this operation returns a blank response.
- Class com.amazonaws.services.cognitoidp.model.CreateUserPoolRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - poolName
```
String poolName
```
      A string used to name the user pool.
    - policies
```
UserPoolPolicyType policies
```
      The policies associated with the new user pool.
    - deletionProtection
```
String deletionProtection
```
      When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.
      
      When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.
    - lambdaConfig
```
LambdaConfigType lambdaConfig
```
      The Lambda trigger configuration information for the new user pool.
      
      In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you must make an extra call to add permission for these event sources to invoke your Lambda function.
      
      For more information on using the Lambda API to add permission, see AddPermission .
      
      For adding permission using the CLI, see add-permission .
    - autoVerifiedAttributes
```
List<E> autoVerifiedAttributes
```
      The attributes to be auto-verified. Possible values: email, phone_number.
    - aliasAttributes
```
List<E> aliasAttributes
```
      Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
    - usernameAttributes
```
List<E> usernameAttributes
```
      Specifies whether a user can use an email address or phone number as a username when they sign up.
    - smsVerificationMessage
```
String smsVerificationMessage
```
      This parameter is no longer used. See VerificationMessageTemplateType.
    - emailVerificationMessage
```
String emailVerificationMessage
```
      This parameter is no longer used. See VerificationMessageTemplateType.
    - emailVerificationSubject
```
String emailVerificationSubject
```
      This parameter is no longer used. See VerificationMessageTemplateType.
    - verificationMessageTemplate
```
VerificationMessageTemplateType verificationMessageTemplate
```
      The template for the verification message that the user sees when the app requests permission to access the user's information.
    - smsAuthenticationMessage
```
String smsAuthenticationMessage
```
      A string representing the SMS authentication message.
    - mfaConfiguration
```
String mfaConfiguration
```
      Specifies MFA configuration details.
    - userAttributeUpdateSettings
```
UserAttributeUpdateSettingsType userAttributeUpdateSettings
```
      The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.
    - deviceConfiguration
```
DeviceConfigurationType deviceConfiguration
```
      The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
      
      When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.
    - emailConfiguration
```
EmailConfigurationType emailConfiguration
```
      The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.
    - smsConfiguration
```
SmsConfigurationType smsConfiguration
```
      The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
    - userPoolTags
```
Map<K,V> userPoolTags
```
      The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
    - adminCreateUserConfig
```
AdminCreateUserConfigType adminCreateUserConfig
```
      The configuration for AdminCreateUser requests.
    - schema
```
List<E> schema
```
      An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
    - userPoolAddOns
```
UserPoolAddOnsType userPoolAddOns
```
      User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.
      
      For more information, see Adding advanced security to a user pool.
    - usernameConfiguration
```
UsernameConfigurationType usernameConfiguration
```
      Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to False (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, username, USERNAME, or UserName, or for email, [email protected] or [email protected]. For most use cases, set case sensitivity to False (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.
      
      This configuration is immutable after you set it. For more information, see UsernameConfigurationType.
    - accountRecoverySetting
```
AccountRecoverySettingType accountRecoverySetting
```
      The available verified method a user can use to recover their password when they call ForgotPassword . You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.
- Class com.amazonaws.services.cognitoidp.model.CreateUserPoolResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - userPool
```
UserPoolType userPool
```
      A container for the user pool details.
- Class com.amazonaws.services.cognitoidp.model.CustomDomainConfigType extends Object implements Serializable
  - Serialized Fields
    - certificateArn
```
String certificateArn
```
      The Amazon Resource Name (ARN) of an Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.
- Class com.amazonaws.services.cognitoidp.model.CustomEmailLambdaVersionConfigType extends Object implements Serializable
  - Serialized Fields
    - lambdaVersion
```
String lambdaVersion
```
      The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.
      
      You must use a LambdaVersion of V1_0 with a custom sender function.
    - lambdaArn
```
String lambdaArn
```
      The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.
- Class com.amazonaws.services.cognitoidp.model.CustomSMSLambdaVersionConfigType extends Object implements Serializable
  - Serialized Fields
    - lambdaVersion
```
String lambdaVersion
```
      The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.
      
      You must use a LambdaVersion of V1_0 with a custom sender function.
    - lambdaArn
```
String lambdaArn
```
      The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.
- Class com.amazonaws.services.cognitoidp.model.DeleteGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - groupName
```
String groupName
```
      The name of the group.
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool.
- Class com.amazonaws.services.cognitoidp.model.DeleteGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cognitoidp.model.DeleteIdentityProviderRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID.
    - providerName
```
String providerName
```
      The IdP name.
- Class com.amazonaws.services.cognitoidp.model.DeleteIdentityProviderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cognitoidp.model.DeleteResourceServerRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool that hosts the resource server.
    - identifier
```
String identifier
```
      The identifier for the resource server.
- Class com.amazonaws.services.cognitoidp.model.DeleteResourceServerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cognitoidp.model.DeleteUserAttributesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userAttributeNames
```
List<E> userAttributeNames
```
      An array of strings representing the user attribute names you want to delete.
      
      For custom attributes, you must prependattach the custom: prefix to the front of the attribute name.
    - accessToken
```
String accessToken
```
      A valid access token that Amazon Cognito issued to the user whose attributes you want to delete.
- Class com.amazonaws.services.cognitoidp.model.DeleteUserAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cognitoidp.model.DeleteUserPoolClientRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool where you want to delete the client.
    - clientId
```
String clientId
```
      The app client ID of the app associated with the user pool.
- Class com.amazonaws.services.cognitoidp.model.DeleteUserPoolClientResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cognitoidp.model.DeleteUserPoolDomainRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domain
```
String domain
```
      The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.
    - userPoolId
```
String userPoolId
```
      The user pool ID.
- Class com.amazonaws.services.cognitoidp.model.DeleteUserPoolDomainResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cognitoidp.model.DeleteUserPoolRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool you want to delete.
- Class com.amazonaws.services.cognitoidp.model.DeleteUserPoolResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cognitoidp.model.DeleteUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accessToken
```
String accessToken
```
      A valid access token that Amazon Cognito issued to the user whose user profile you want to delete.
- Class com.amazonaws.services.cognitoidp.model.DeleteUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cognitoidp.model.DescribeIdentityProviderRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID.
    - providerName
```
String providerName
```
      The IdP name.
- Class com.amazonaws.services.cognitoidp.model.DescribeIdentityProviderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - identityProvider
```
IdentityProviderType identityProvider
```
      The identity provider details.
- Class com.amazonaws.services.cognitoidp.model.DescribeResourceServerRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool that hosts the resource server.
    - identifier
```
String identifier
```
      A unique resource server identifier for the resource server. The identifier can be an API friendly name like solar-system-data. You can also set an API URL like https://solar-system-data-api.example.com as your identifier.
      
      Amazon Cognito represents scopes in the access token in the format $resource-server-identifier/$scope. Longer scope-identifier strings increase the size of your access tokens.
- Class com.amazonaws.services.cognitoidp.model.DescribeResourceServerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - resourceServer
```
ResourceServerType resourceServer
```
      The resource server.
- Class com.amazonaws.services.cognitoidp.model.DescribeRiskConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID.
    - clientId
```
String clientId
```
      The app client ID.
- Class com.amazonaws.services.cognitoidp.model.DescribeRiskConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - riskConfiguration
```
RiskConfigurationType riskConfiguration
```
      The risk configuration.
- Class com.amazonaws.services.cognitoidp.model.DescribeUserImportJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool that the users are being imported into.
    - jobId
```
String jobId
```
      The job ID for the user import job.
- Class com.amazonaws.services.cognitoidp.model.DescribeUserImportJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - userImportJob
```
UserImportJobType userImportJob
```
      The job object that represents the user import job.
- Class com.amazonaws.services.cognitoidp.model.DescribeUserPoolClientRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool you want to describe.
    - clientId
```
String clientId
```
      The app client ID of the app associated with the user pool.
- Class com.amazonaws.services.cognitoidp.model.DescribeUserPoolClientResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - userPoolClient
```
UserPoolClientType userPoolClient
```
      The user pool client from a server response to describe the user pool client.
- Class com.amazonaws.services.cognitoidp.model.DescribeUserPoolDomainRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domain
```
String domain
```
      The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.
- Class com.amazonaws.services.cognitoidp.model.DescribeUserPoolDomainResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - domainDescription
```
DomainDescriptionType domainDescription
```
      A domain description object containing information about the domain.
- Class com.amazonaws.services.cognitoidp.model.DescribeUserPoolRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool you want to describe.
- Class com.amazonaws.services.cognitoidp.model.DescribeUserPoolResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - userPool
```
UserPoolType userPool
```
      The container of metadata returned by the server to describe the pool.
- Class com.amazonaws.services.cognitoidp.model.DeviceConfigurationType extends Object implements Serializable
  - Serialized Fields
    - challengeRequiredOnNewDevice
```
Boolean challengeRequiredOnNewDevice
```
      When true, a remembered device can sign in with device authentication instead of SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).
      
      Whether or not ChallengeRequiredOnNewDevice is true, users who sign in with devices that have not been confirmed or remembered must still provide a second factor in a user pool that requires MFA.
    - deviceOnlyRememberedOnUserPrompt
```
Boolean deviceOnlyRememberedOnUserPrompt
```
      When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a ConfirmDevice API request. In your app, create a prompt for your user to choose whether they want to remember their device. Return the user's choice in an UpdateDeviceStatus API request.
      
      When DeviceOnlyRememberedOnUserPrompt is false, Amazon Cognito immediately remembers devices that you register in a ConfirmDevice API request.
- Class com.amazonaws.services.cognitoidp.model.DeviceSecretVerifierConfigType extends Object implements Serializable
  - Serialized Fields
    - passwordVerifier
```
String passwordVerifier
```
      The password verifier.
    - salt
```
String salt
```
      The salt
- Class com.amazonaws.services.cognitoidp.model.DeviceType extends Object implements Serializable
  - Serialized Fields
    - deviceKey
```
String deviceKey
```
      The device key.
    - deviceAttributes
```
List<E> deviceAttributes
```
      The device attributes.
    - deviceCreateDate
```
Date deviceCreateDate
```
      The creation date of the device.
    - deviceLastModifiedDate
```
Date deviceLastModifiedDate
```
      The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
    - deviceLastAuthenticatedDate
```
Date deviceLastAuthenticatedDate
```
      The date when the device was last authenticated.
- Class com.amazonaws.services.cognitoidp.model.DomainDescriptionType extends Object implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID.
    - aWSAccountId
```
String aWSAccountId
```
      The Amazon Web Services ID for the user pool owner.
    - domain
```
String domain
```
      The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.
    - s3Bucket
```
String s3Bucket
```
      The Amazon S3 bucket where the static files for this domain are stored.
    - cloudFrontDistribution
```
String cloudFrontDistribution
```
      The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
    - version
```
String version
```
      The app version.
    - status
```
String status
```
      The domain status.
    - customDomainConfig
```
CustomDomainConfigType customDomainConfig
```
      The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
- Class com.amazonaws.services.cognitoidp.model.DuplicateProviderException extends AWSCognitoIdentityProviderException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidp.model.EmailConfigurationType extends Object implements Serializable
  - Serialized Fields
    - sourceArn
```
String sourceArn
```
      The ARN of a verified email address or an address from a verified domain in Amazon SES. You can set a SourceArn email from a verified domain only with an API request. You can set a verified email address, but not an address in a verified domain, in the Amazon Cognito console. Amazon Cognito uses the email address that you provide in one of the following ways, depending on the value that you specify for the EmailSendingAccount parameter:
      
      If you specify COGNITO_DEFAULT, Amazon Cognito uses this address as the custom FROM address when it emails your users using its built-in email account.
      
      If you specify DEVELOPER, Amazon Cognito emails your users with this address by calling Amazon SES on your behalf.
      
      The Region value of the SourceArn parameter must indicate a supported Amazon Web Services Region of your user pool. Typically, the Region in the SourceArn and the user pool Region are the same. For more information, see Amazon SES email configuration regions in the Amazon Cognito Developer Guide.
    - replyToEmailAddress
```
String replyToEmailAddress
```
      The destination to which the receiver of the email should reply.
    - emailSendingAccount
```
String emailSendingAccount
```
      Specifies whether Amazon Cognito uses its built-in functionality to send your users email messages, or uses your Amazon Simple Email Service email configuration. Specify one of the following values:
      
      COGNITO_DEFAULT
      
      When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is less than the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration.
      
      To look up the email delivery limit for the default option, see Limits in the Amazon Cognito Developer Guide.
      
      The default FROM address is [email protected]. To customize the FROM address, provide the Amazon Resource Name (ARN) of an Amazon SES verified email address for the SourceArn parameter.
      
      DEVELOPER
      
      When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your Amazon Web Services account.
      
      If you use this option, provide the ARN of an Amazon SES verified email address for the SourceArn parameter.
      
      Before Amazon Cognito can email your users, it requires additional permissions to call Amazon SES on your behalf. When you update your user pool with this option, Amazon Cognito creates a service-linked role, which is a type of role in your Amazon Web Services account. This role contains the permissions that allow you to access Amazon SES and send email messages from your email address. For more information about the service-linked role that Amazon Cognito creates, see Using Service-Linked Roles for Amazon Cognito in the Amazon Cognito Developer Guide.
    - from
```
String from
```
      Either the sender’s email address or the sender’s name with their email address. For example, [email protected] or Test User <[email protected]>. This address appears before the body of the email.
    - configurationSet
```
String configurationSet
```
      The set of configuration rules that can be applied to emails sent using Amazon Simple Email Service. A configuration set is applied to an email by including a reference to the configuration set in the headers of the email. Once applied, all of the rules in that configuration set are applied to the email. Configuration sets can be used to apply the following types of rules to emails:
      
      Event publishing
      
      Amazon Simple Email Service can track the number of send, delivery, open, click, bounce, and complaint events for each email sent. Use event publishing to send information about these events to other Amazon Web Services services such as and Amazon CloudWatch
      
      IP pool management
      
      When leasing dedicated IP addresses with Amazon Simple Email Service, you can create groups of IP addresses, called dedicated IP pools. You can then associate the dedicated IP pools with configuration sets.
- Class com.amazonaws.services.cognitoidp.model.EnableSoftwareTokenMFAException extends AWSCognitoIdentityProviderException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidp.model.EventContextDataType extends Object implements Serializable
  - Serialized Fields
    - ipAddress
```
String ipAddress
```
      The source IP address of your user's device.
    - deviceName
```
String deviceName
```
      The user's device name.
    - timezone
```
String timezone
```
      The user's time zone.
    - city
```
String city
```
      The user's city.
    - country
```
String country
```
      The user's country.
- Class com.amazonaws.services.cognitoidp.model.EventFeedbackType extends Object implements Serializable
  - Serialized Fields
    - feedbackValue
```
String feedbackValue
```
      The authentication event feedback value. When you provide a FeedbackValue value of valid, you tell Amazon Cognito that you trust a user session where Amazon Cognito has evaluated some level of risk. When you provide a FeedbackValue value of invalid, you tell Amazon Cognito that you don't trust a user session, or you don't believe that Amazon Cognito evaluated a high-enough risk level.
    - provider
```
String provider
```
      The provider.
    - feedbackDate
```
Date feedbackDate
```
      The event feedback date.
- Class com.amazonaws.services.cognitoidp.model.EventRiskType extends Object implements Serializable
  - Serialized Fields
    - riskDecision
```
String riskDecision
```
      The risk decision.
    - riskLevel
```
String riskLevel
```
      The risk level.
    - compromisedCredentialsDetected
```
Boolean compromisedCredentialsDetected
```
      Indicates whether compromised credentials were detected during an authentication event.
- Class com.amazonaws.services.cognitoidp.model.ExpiredCodeException extends AWSCognitoIdentityProviderException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidp.model.ForbiddenException extends AWSCognitoIdentityProviderException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidp.model.ForgetDeviceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accessToken
```
String accessToken
```
      A valid access token that Amazon Cognito issued to the user whose registered device you want to forget.
    - deviceKey
```
String deviceKey
```
      The device key.
- Class com.amazonaws.services.cognitoidp.model.ForgetDeviceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cognitoidp.model.ForgotPasswordRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientId
```
String clientId
```
      The ID of the client associated with the user pool.
    - secretHash
```
String secretHash
```
      A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
    - userContextData
```
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.
    - username
```
String username
```
      The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.
    - analyticsMetadata
```
AnalyticsMetadataType analyticsMetadata
```
      The Amazon Pinpoint analytics metadata that contributes to your metrics for ForgotPassword calls.
    - clientMetadata
```
Map<K,V> clientMetadata
```
      A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
      
      You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and user migration. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ForgotPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
      
      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.
- Class com.amazonaws.services.cognitoidp.model.ForgotPasswordResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - codeDeliveryDetails
```
CodeDeliveryDetailsType codeDeliveryDetails
```
      The code delivery details returned by the server in response to the request to reset a password.
- Class com.amazonaws.services.cognitoidp.model.GetCSVHeaderRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool that the users are to be imported into.
- Class com.amazonaws.services.cognitoidp.model.GetCSVHeaderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool that the users are to be imported into.
    - cSVHeader
```
List<E> cSVHeader
```
      The header information of the CSV file for the user import job.
- Class com.amazonaws.services.cognitoidp.model.GetDeviceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - deviceKey
```
String deviceKey
```
      The device key.
    - accessToken
```
String accessToken
```
      A valid access token that Amazon Cognito issued to the user whose device information you want to request.
- Class com.amazonaws.services.cognitoidp.model.GetDeviceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - device
```
DeviceType device
```
      The device.
- Class com.amazonaws.services.cognitoidp.model.GetGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - groupName
```
String groupName
```
      The name of the group.
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool.
- Class com.amazonaws.services.cognitoidp.model.GetGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - group
```
GroupType group
```
      The group object for the group.
- Class com.amazonaws.services.cognitoidp.model.GetIdentityProviderByIdentifierRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID.
    - idpIdentifier
```
String idpIdentifier
```
      The IdP identifier.
- Class com.amazonaws.services.cognitoidp.model.GetIdentityProviderByIdentifierResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - identityProvider
```
IdentityProviderType identityProvider
```
      The identity provider details.
- Class com.amazonaws.services.cognitoidp.model.GetLogDeliveryConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The ID of the user pool where you want to view detailed activity logging configuration.
- Class com.amazonaws.services.cognitoidp.model.GetLogDeliveryConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - logDeliveryConfiguration
```
LogDeliveryConfigurationType logDeliveryConfiguration
```
      The detailed activity logging configuration of the requested user pool.
- Class com.amazonaws.services.cognitoidp.model.GetSigningCertificateRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID.
- Class com.amazonaws.services.cognitoidp.model.GetSigningCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - certificate
```
String certificate
```
      The signing certificate.
- Class com.amazonaws.services.cognitoidp.model.GetUICustomizationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool.
    - clientId
```
String clientId
```
      The client ID for the client app.
- Class com.amazonaws.services.cognitoidp.model.GetUICustomizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - uICustomization
```
UICustomizationType uICustomization
```
      The UI customization information.
- Class com.amazonaws.services.cognitoidp.model.GetUserAttributeVerificationCodeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accessToken
```
String accessToken
```
      A non-expired access token for the user whose attribute verification code you want to generate.
    - attributeName
```
String attributeName
```
      The attribute name returned by the server response to get the user attribute verification code.
    - clientMetadata
```
Map<K,V> clientMetadata
```
      A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
      
      You create custom workflows by assigning Lambda functions to user pool triggers. When you use the GetUserAttributeVerificationCode API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your GetUserAttributeVerificationCode request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
      
      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.
- Class com.amazonaws.services.cognitoidp.model.GetUserAttributeVerificationCodeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - codeDeliveryDetails
```
CodeDeliveryDetailsType codeDeliveryDetails
```
      The code delivery details returned by the server in response to the request to get the user attribute verification code.
- Class com.amazonaws.services.cognitoidp.model.GetUserPoolMfaConfigRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID.
- Class com.amazonaws.services.cognitoidp.model.GetUserPoolMfaConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - smsMfaConfiguration
```
SmsMfaConfigType smsMfaConfiguration
```
      The SMS text message multi-factor authentication (MFA) configuration.
    - softwareTokenMfaConfiguration
```
SoftwareTokenMfaConfigType softwareTokenMfaConfiguration
```
      The software token multi-factor authentication (MFA) configuration.
    - mfaConfiguration
```
String mfaConfiguration
```
      The multi-factor authentication (MFA) configuration. Valid values include:
      
      OFF MFA won't be used for any users.
      
      ON MFA is required for all users to sign in.
      
      OPTIONAL MFA will be required only for individual users who have an MFA factor activated.
- Class com.amazonaws.services.cognitoidp.model.GetUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accessToken
```
String accessToken
```
      A non-expired access token for the user whose information you want to query.
- Class com.amazonaws.services.cognitoidp.model.GetUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - username
```
String username
```
      The username of the user that you requested.
    - userAttributes
```
List<E> userAttributes
```
      An array of name-value pairs representing user attributes.
      
      For custom attributes, you must prepend the custom: prefix to the attribute name.
    - mFAOptions
```
List<E> mFAOptions
```
      This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.
    - preferredMfaSetting
```
String preferredMfaSetting
```
      The user's preferred MFA setting.
    - userMFASettingList
```
List<E> userMFASettingList
```
      The MFA options that are activated for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.
- Class com.amazonaws.services.cognitoidp.model.GlobalSignOutRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accessToken
```
String accessToken
```
      A valid access token that Amazon Cognito issued to the user who you want to sign out.
- Class com.amazonaws.services.cognitoidp.model.GlobalSignOutResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cognitoidp.model.GroupExistsException extends AWSCognitoIdentityProviderException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidp.model.GroupType extends Object implements Serializable
  - Serialized Fields
    - groupName
```
String groupName
```
      The name of the group.
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool.
    - description
```
String description
```
      A string containing the description of the group.
    - roleArn
```
String roleArn
```
      The role Amazon Resource Name (ARN) for the group.
    - precedence
```
Integer precedence
```
      A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher ornull Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the cognito:roles and cognito:preferred_role claims.
      
      Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim isn't set in users' tokens.
      
      The default Precedence value is null.
    - lastModifiedDate
```
Date lastModifiedDate
```
      The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
    - creationDate
```
Date creationDate
```
      The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
- Class com.amazonaws.services.cognitoidp.model.HttpHeader extends Object implements Serializable
  - Serialized Fields
    - headerName
```
String headerName
```
      The header name.
    - headerValue
```
String headerValue
```
      The header value.
- Class com.amazonaws.services.cognitoidp.model.IdentityProviderType extends Object implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID.
    - providerName
```
String providerName
```
      The IdP name.
    - providerType
```
String providerType
```
      The IdP type.
    - providerDetails
```
Map<K,V> providerDetails
```
      The scopes, URLs, and identifiers for your external identity provider. The following examples describe the provider detail keys for each IdP type. These values and their schema are subject to change. Social IdP authorize_scopes values must match the values listed here.
      
      OpenID Connect (OIDC)
      
      Amazon Cognito accepts the following elements when it can't discover endpoint URLs from oidc_issuer: attributes_url, authorize_url, jwks_uri, token_url.
      
      Create or update request: "ProviderDetails": { "attributes_request_method": "GET", "attributes_url": "https://auth.example.com/userInfo", "authorize_scopes": "openid profile email", "authorize_url": "https://auth.example.com/authorize", "client_id": "1example23456789", "client_secret": "provider-app-client-secret", "jwks_uri": "https://auth.example.com/.well-known/jwks.json", "oidc_issuer": "https://auth.example.com", "token_url": "https://example.com/token" }
      
      Describe response: "ProviderDetails": { "attributes_request_method": "GET", "attributes_url": "https://auth.example.com/userInfo", "attributes_url_add_attributes": "false", "authorize_scopes": "openid profile email", "authorize_url": "https://auth.example.com/authorize", "client_id": "1example23456789", "client_secret": "provider-app-client-secret", "jwks_uri": "https://auth.example.com/.well-known/jwks.json", "oidc_issuer": "https://auth.example.com", "token_url": "https://example.com/token" }
      
      SAML
      
      Create or update request with Metadata URL: "ProviderDetails": { "IDPInit": "true", "IDPSignout": "true", "EncryptedResponses" : "true", "MetadataURL": "https://auth.example.com/sso/saml/metadata", "RequestSigningAlgorithm": "rsa-sha256" }
      
      Create or update request with Metadata file: "ProviderDetails": { "IDPInit": "true", "IDPSignout": "true", "EncryptedResponses" : "true", "MetadataFile": "[metadata XML]", "RequestSigningAlgorithm": "rsa-sha256" }
      
      The value of MetadataFile must be the plaintext metadata document with all quote (") characters escaped by backslashes.
      
      Describe response: "ProviderDetails": { "IDPInit": "true", "IDPSignout": "true", "EncryptedResponses" : "true", "ActiveEncryptionCertificate": "[certificate]", "MetadataURL": "https://auth.example.com/sso/saml/metadata", "RequestSigningAlgorithm": "rsa-sha256", "SLORedirectBindingURI": "https://auth.example.com/slo/saml", "SSORedirectBindingURI": "https://auth.example.com/sso/saml" }
      
      LoginWithAmazon
      
      Create or update request: "ProviderDetails": { "authorize_scopes": "profile postal_code", "client_id": "amzn1.application-oa2-client.1example23456789", "client_secret": "provider-app-client-secret"
      
      Describe response: "ProviderDetails": { "attributes_url": "https://api.amazon.com/user/profile", "attributes_url_add_attributes": "false", "authorize_scopes": "profile postal_code", "authorize_url": "https://www.amazon.com/ap/oa", "client_id": "amzn1.application-oa2-client.1example23456789", "client_secret": "provider-app-client-secret", "token_request_method": "POST", "token_url": "https://api.amazon.com/auth/o2/token" }
      
      Google
      
      Create or update request: "ProviderDetails": { "authorize_scopes": "email profile openid", "client_id": "1example23456789.apps.googleusercontent.com", "client_secret": "provider-app-client-secret" }
      
      Describe response: "ProviderDetails": { "attributes_url": "https://people.googleapis.com/v1/people/me?personFields=", "attributes_url_add_attributes": "true", "authorize_scopes": "email profile openid", "authorize_url": "https://accounts.google.com/o/oauth2/v2/auth", "client_id": "1example23456789.apps.googleusercontent.com", "client_secret": "provider-app-client-secret", "oidc_issuer": "https://accounts.google.com", "token_request_method": "POST", "token_url": "https://www.googleapis.com/oauth2/v4/token" }
      
      SignInWithApple
      
      Create or update request: "ProviderDetails": { "authorize_scopes": "email name", "client_id": "com.example.cognito", "private_key": "1EXAMPLE", "key_id": "2EXAMPLE", "team_id": "3EXAMPLE" }
      
      Describe response: "ProviderDetails": { "attributes_url_add_attributes": "false", "authorize_scopes": "email name", "authorize_url": "https://appleid.apple.com/auth/authorize", "client_id": "com.example.cognito", "key_id": "1EXAMPLE", "oidc_issuer": "https://appleid.apple.com", "team_id": "2EXAMPLE", "token_request_method": "POST", "token_url": "https://appleid.apple.com/auth/token" }
      
      Facebook
      
      Create or update request: "ProviderDetails": { "api_version": "v17.0", "authorize_scopes": "public_profile, email", "client_id": "1example23456789", "client_secret": "provider-app-client-secret" }
      
      Describe response: "ProviderDetails": { "api_version": "v17.0", "attributes_url": "https://graph.facebook.com/v17.0/me?fields=", "attributes_url_add_attributes": "true", "authorize_scopes": "public_profile, email", "authorize_url": "https://www.facebook.com/v17.0/dialog/oauth", "client_id": "1example23456789", "client_secret": "provider-app-client-secret", "token_request_method": "GET", "token_url": "https://graph.facebook.com/v17.0/oauth/access_token" }
    - attributeMapping
```
Map<K,V> attributeMapping
```
      A mapping of IdP attributes to standard and custom user pool attributes.
    - idpIdentifiers
```
List<E> idpIdentifiers
```
      A list of IdP identifiers.
    - lastModifiedDate
```
Date lastModifiedDate
```
      The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
    - creationDate
```
Date creationDate
```
      The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
- Class com.amazonaws.services.cognitoidp.model.InitiateAuthRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - authFlow
```
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.
    - authParameters
```
Map<K,V> 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.
    - clientMetadata
```
Map<K,V> 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
      
      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.
    - clientId
```
String clientId
```
      The app client ID.
    - analyticsMetadata
```
AnalyticsMetadataType analyticsMetadata
```
      The Amazon Pinpoint analytics metadata that contributes to your metrics for InitiateAuth calls.
    - userContextData
```
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.
- Class com.amazonaws.services.cognitoidp.model.InitiateAuthResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - challengeName
```
String challengeName
```
      The name of the challenge that you're responding to with this call. This name is returned in the InitiateAuth response if you must pass another challenge.
      
      Valid values include the following:
      
      All of the following challenges require USERNAME and SECRET_HASH (if applicable) in the parameters.
      
      SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered via SMS.
      
      PASSWORD_VERIFIER: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side SRP calculations.
      
      CUSTOM_CHALLENGE: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.
      
      DEVICE_SRP_AUTH: If device tracking was activated on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.
      
      DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, but for devices only.
      
      NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful first login.
      
      Respond to this challenge with NEW_PASSWORD and any required attributes that Amazon Cognito returned in the requiredAttributes parameter. You can also set values for attributes that aren't required by your user pool and that your app client can write. For more information, see RespondToAuthChallenge.
      
      In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. In RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the UpdateUserAttributes API operation to modify the value of any additional attributes.
      
      MFA_SETUP: For users who are required to setup an MFA factor before they can sign in. The MFA types activated for the user pool will be listed in the challenge parameters MFAS_CAN_SETUP value.
      
      To set up software token MFA, use the session returned here from InitiateAuth as an input to AssociateSoftwareToken. Use the session returned by VerifySoftwareToken as an input to RespondToAuthChallenge with challenge name MFA_SETUP to complete sign-in. To set up SMS MFA, an administrator should help the user to add a phone number to their account, and then the user should call InitiateAuth again to restart sign-in.
    - session
```
String session
```
      The session that should pass both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
    - challengeParameters
```
Map<K,V> challengeParameters
```
      The challenge parameters. These are returned in the InitiateAuth response if you must pass another challenge. The responses in this parameter should be used to compute inputs to the next call ( RespondToAuthChallenge).
      
      All challenges require USERNAME and SECRET_HASH (if applicable).
    - authenticationResult
```
AuthenticationResultType authenticationResult
```
      The result of the authentication response. This result is only returned if the caller doesn't need to pass another challenge. If the caller does need to pass another challenge before it gets tokens, ChallengeName, ChallengeParameters, and Session are returned.
- Class com.amazonaws.services.cognitoidp.model.InternalErrorException extends AWSCognitoIdentityProviderException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidp.model.InvalidEmailRoleAccessPolicyException extends AWSCognitoIdentityProviderException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidp.model.InvalidLambdaResponseException extends AWSCognitoIdentityProviderException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidp.model.InvalidOAuthFlowException extends AWSCognitoIdentityProviderException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidp.model.InvalidParameterException extends AWSCognitoIdentityProviderException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidp.model.InvalidPasswordException extends AWSCognitoIdentityProviderException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidp.model.InvalidSmsRoleAccessPolicyException extends AWSCognitoIdentityProviderException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidp.model.InvalidSmsRoleTrustRelationshipException extends AWSCognitoIdentityProviderException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidp.model.InvalidUserPoolConfigurationException extends AWSCognitoIdentityProviderException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidp.model.LambdaConfigType extends Object implements Serializable
  - Serialized Fields
    - preSignUp
```
String preSignUp
```
      A pre-registration Lambda trigger.
    - customMessage
```
String customMessage
```
      A custom Message Lambda trigger.
    - postConfirmation
```
String postConfirmation
```
      A post-confirmation Lambda trigger.
    - preAuthentication
```
String preAuthentication
```
      A pre-authentication Lambda trigger.
    - postAuthentication
```
String postAuthentication
```
      A post-authentication Lambda trigger.
    - defineAuthChallenge
```
String defineAuthChallenge
```
      Defines the authentication challenge.
    - createAuthChallenge
```
String createAuthChallenge
```
      Creates an authentication challenge.
    - verifyAuthChallengeResponse
```
String verifyAuthChallengeResponse
```
      Verifies the authentication challenge response.
    - preTokenGeneration
```
String preTokenGeneration
```
      The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.
      
      Set this parameter for legacy purposes. If you also set an ARN in PreTokenGenerationConfig, its value must be identical to PreTokenGeneration. For new instances of pre token generation triggers, set the LambdaArn of PreTokenGenerationConfig.
      
      You can set

Serialized Form

Package com.amazonaws.services.cognitoidp.model

Class com.amazonaws.services.cognitoidp.model.AccountRecoverySettingType extends Object implements Serializable

Serialized Fields

recoveryMechanisms

Class com.amazonaws.services.cognitoidp.model.AccountTakeoverActionsType extends Object implements Serializable

Serialized Fields

lowAction

mediumAction

highAction

Class com.amazonaws.services.cognitoidp.model.AccountTakeoverActionType extends Object implements Serializable

Serialized Fields

notify

eventAction

Class com.amazonaws.services.cognitoidp.model.AccountTakeoverRiskConfigurationType extends Object implements Serializable

Serialized Fields

notifyConfiguration

actions

Class com.amazonaws.services.cognitoidp.model.AddCustomAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userPoolId

customAttributes

Class com.amazonaws.services.cognitoidp.model.AddCustomAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.cognitoidp.model.AdminAddUserToGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userPoolId

username

groupName

Class com.amazonaws.services.cognitoidp.model.AdminAddUserToGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.cognitoidp.model.AdminConfirmSignUpRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userPoolId

username

clientMetadata

Class com.amazonaws.services.cognitoidp.model.AdminConfirmSignUpResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.cognitoidp.model.AdminCreateUserConfigType extends Object implements Serializable

Serialized Fields

allowAdminCreateUserOnly

unusedAccountValidityDays

inviteMessageTemplate

Class com.amazonaws.services.cognitoidp.model.AdminCreateUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userPoolId

username

userAttributes

validationData

temporaryPassword

forceAliasCreation

messageAction

desiredDeliveryMediums

clientMetadata

Class com.amazonaws.services.cognitoidp.model.AdminCreateUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

user

Class com.amazonaws.services.cognitoidp.model.AdminDeleteUserAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userPoolId

username

userAttributeNames

Class com.amazonaws.services.cognitoidp.model.AdminDeleteUserAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.cognitoidp.model.AdminDeleteUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userPoolId

username

Class com.amazonaws.services.cognitoidp.model.AdminDeleteUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.cognitoidp.model.AdminDisableProviderForUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userPoolId

user

Class com.amazonaws.services.cognitoidp.model.AdminDisableProviderForUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.cognitoidp.model.AdminDisableUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userPoolId

username

Class com.amazonaws.services.cognitoidp.model.AdminDisableUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.cognitoidp.model.AdminEnableUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userPoolId

username

Class com.amazonaws.services.cognitoidp.model.AdminEnableUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable