* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.cognitoidp.AbstractAWSCognitoIdentityProviderAsync} instead. *
**
* Using the Amazon Cognito user pools API, you can create a user pool to manage directories and users. You can * authenticate a user to obtain tokens related to user identity and access policies. *
** This API reference provides information about user pools in Amazon Cognito user pools. *
** For more information, see the Amazon Cognito * Documentation. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSCognitoIdentityProviderAsync extends AWSCognitoIdentityProvider { /** ** Adds additional user attributes to the user pool schema. *
* * @param addCustomAttributesRequest * Represents the request to add custom attributes. * @return A Java Future containing the result of the AddCustomAttributes operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.AddCustomAttributes * @see AWS API Documentation */ java.util.concurrent.Future* Adds additional user attributes to the user pool schema. *
* * @param addCustomAttributesRequest * Represents the request to add custom attributes. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the AddCustomAttributes operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.AddCustomAttributes * @see AWS API Documentation */ java.util.concurrent.Future* Adds the specified user to the specified group. *
** Calling this action requires developer credentials. *
* * @param adminAddUserToGroupRequest * @return A Java Future containing the result of the AdminAddUserToGroup operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.AdminAddUserToGroup * @see AWS API Documentation */ java.util.concurrent.Future* Adds the specified user to the specified group. *
** Calling this action requires developer credentials. *
* * @param adminAddUserToGroupRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the AdminAddUserToGroup operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.AdminAddUserToGroup * @see AWS API Documentation */ java.util.concurrent.Future* Confirms user registration as an admin without using a confirmation code. Works on any user. *
** Calling this action requires developer credentials. *
* * @param adminConfirmSignUpRequest * Represents the request to confirm user registration. * @return A Java Future containing the result of the AdminConfirmSignUp operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.AdminConfirmSignUp * @see AWS * API Documentation */ java.util.concurrent.Future* Confirms user registration as an admin without using a confirmation code. Works on any user. *
** Calling this action requires developer credentials. *
* * @param adminConfirmSignUpRequest * Represents the request to confirm user registration. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the AdminConfirmSignUp operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.AdminConfirmSignUp * @see AWS * API Documentation */ java.util.concurrent.Future* Creates a new user in the specified user pool. *
*
* If MessageAction isn't set, the default is to send a welcome message via email or phone (SMS).
*
* This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to * register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text * messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered * number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, * activate their accounts, or sign in. *
** If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple * Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send * messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move * out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. *
** This message is based on a template that you configured in your call to create or update a user pool. This * template includes your custom sign-up instructions and placeholders for user name and temporary password. *
*
* Alternatively, you can call AdminCreateUser with SUPPRESS for the
* MessageAction parameter, and Amazon Cognito won't send any email.
*
* In either case, the user will be in the FORCE_CHANGE_PASSWORD state until they sign in and change
* their password.
*
* AdminCreateUser requires developer credentials.
*
* Creates a new user in the specified user pool. *
*
* If MessageAction isn't set, the default is to send a welcome message via email or phone (SMS).
*
* This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to * register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text * messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered * number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, * activate their accounts, or sign in. *
** If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple * Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send * messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move * out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. *
** This message is based on a template that you configured in your call to create or update a user pool. This * template includes your custom sign-up instructions and placeholders for user name and temporary password. *
*
* Alternatively, you can call AdminCreateUser with SUPPRESS for the
* MessageAction parameter, and Amazon Cognito won't send any email.
*
* In either case, the user will be in the FORCE_CHANGE_PASSWORD state until they sign in and change
* their password.
*
* AdminCreateUser requires developer credentials.
*
* Deletes a user as an administrator. Works on any user. *
** Calling this action requires developer credentials. *
* * @param adminDeleteUserRequest * Represents the request to delete a user as an administrator. * @return A Java Future containing the result of the AdminDeleteUser operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.AdminDeleteUser * @see AWS * API Documentation */ java.util.concurrent.Future* Deletes a user as an administrator. Works on any user. *
** Calling this action requires developer credentials. *
* * @param adminDeleteUserRequest * Represents the request to delete a user as an administrator. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the AdminDeleteUser operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.AdminDeleteUser * @see AWS * API Documentation */ java.util.concurrent.Future* Deletes the user attributes in a user pool as an administrator. Works on any user. *
** Calling this action requires developer credentials. *
* * @param adminDeleteUserAttributesRequest * Represents the request to delete user attributes as an administrator. * @return A Java Future containing the result of the AdminDeleteUserAttributes operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.AdminDeleteUserAttributes * @see AWS API Documentation */ java.util.concurrent.Future* Deletes the user attributes in a user pool as an administrator. Works on any user. *
** Calling this action requires developer credentials. *
* * @param adminDeleteUserAttributesRequest * Represents the request to delete user attributes as an administrator. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the AdminDeleteUserAttributes operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.AdminDeleteUserAttributes * @see AWS API Documentation */ java.util.concurrent.Future
* Prevents the user from signing in with the specified external (SAML or social) identity provider (IdP). If the
* user that you want to deactivate is a Amazon Cognito user pools native username + password user, they can't use
* their password to sign in. If the user to deactivate is a linked external IdP user, any link between that user
* and an existing user is removed. When the external user signs in again, and the user is no longer attached to the
* previously linked DestinationUser, the user must create a new user account. See AdminLinkProviderForUser.
*
* This action is enabled only for admin access and requires developer credentials. *
*
* The ProviderName must match the value specified when creating an IdP for the pool.
*
* To deactivate a native username + password user, the ProviderName value must be Cognito
* and the ProviderAttributeName must be Cognito_Subject. The
* ProviderAttributeValue must be the name that is used in the user pool for the user.
*
* The ProviderAttributeName must always be Cognito_Subject for social IdPs. The
* ProviderAttributeValue must always be the exact subject that was used when the user was originally
* linked as a source user.
*
* For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign in,
* the ProviderAttributeName and ProviderAttributeValue must be the same values that were
* used for the SourceUser when the identities were originally linked using
* AdminLinkProviderForUser call. (If the linking was done with ProviderAttributeName set
* to Cognito_Subject, the same applies here). However, if the user has already signed in, the
* ProviderAttributeName must be Cognito_Subject and ProviderAttributeValue
* must be the subject of the SAML assertion.
*
* Prevents the user from signing in with the specified external (SAML or social) identity provider (IdP). If the
* user that you want to deactivate is a Amazon Cognito user pools native username + password user, they can't use
* their password to sign in. If the user to deactivate is a linked external IdP user, any link between that user
* and an existing user is removed. When the external user signs in again, and the user is no longer attached to the
* previously linked DestinationUser, the user must create a new user account. See AdminLinkProviderForUser.
*
* This action is enabled only for admin access and requires developer credentials. *
*
* The ProviderName must match the value specified when creating an IdP for the pool.
*
* To deactivate a native username + password user, the ProviderName value must be Cognito
* and the ProviderAttributeName must be Cognito_Subject. The
* ProviderAttributeValue must be the name that is used in the user pool for the user.
*
* The ProviderAttributeName must always be Cognito_Subject for social IdPs. The
* ProviderAttributeValue must always be the exact subject that was used when the user was originally
* linked as a source user.
*
* For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign in,
* the ProviderAttributeName and ProviderAttributeValue must be the same values that were
* used for the SourceUser when the identities were originally linked using
* AdminLinkProviderForUser call. (If the linking was done with ProviderAttributeName set
* to Cognito_Subject, the same applies here). However, if the user has already signed in, the
* ProviderAttributeName must be Cognito_Subject and ProviderAttributeValue
* must be the subject of the SAML assertion.
*
* Deactivates a user and revokes all access tokens for the user. A deactivated user can't sign in, but still
* appears in the responses to GetUser and ListUsers API requests.
*
* You must make this API request with Amazon Web Services credentials that have
* cognito-idp:AdminDisableUser permissions.
*
* Deactivates a user and revokes all access tokens for the user. A deactivated user can't sign in, but still
* appears in the responses to GetUser and ListUsers API requests.
*
* You must make this API request with Amazon Web Services credentials that have
* cognito-idp:AdminDisableUser permissions.
*
* Enables the specified user as an administrator. Works on any user. *
** Calling this action requires developer credentials. *
* * @param adminEnableUserRequest * Represents the request that enables the user as an administrator. * @return A Java Future containing the result of the AdminEnableUser operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.AdminEnableUser * @see AWS * API Documentation */ java.util.concurrent.Future* Enables the specified user as an administrator. Works on any user. *
** Calling this action requires developer credentials. *
* * @param adminEnableUserRequest * Represents the request that enables the user as an administrator. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the AdminEnableUser operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.AdminEnableUser * @see AWS * API Documentation */ java.util.concurrent.Future* Forgets the device, as an administrator. *
** Calling this action requires developer credentials. *
* * @param adminForgetDeviceRequest * Sends the forgot device request, as an administrator. * @return A Java Future containing the result of the AdminForgetDevice operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.AdminForgetDevice * @see AWS * API Documentation */ java.util.concurrent.Future* Forgets the device, as an administrator. *
** Calling this action requires developer credentials. *
* * @param adminForgetDeviceRequest * Sends the forgot device request, as an administrator. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the AdminForgetDevice operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.AdminForgetDevice * @see AWS * API Documentation */ java.util.concurrent.Future* Gets the device, as an administrator. *
** Calling this action requires developer credentials. *
* * @param adminGetDeviceRequest * Represents the request to get the device, as an administrator. * @return A Java Future containing the result of the AdminGetDevice operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.AdminGetDevice * @see AWS API * Documentation */ java.util.concurrent.Future* Gets the device, as an administrator. *
** Calling this action requires developer credentials. *
* * @param adminGetDeviceRequest * Represents the request to get the device, as an administrator. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the AdminGetDevice operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.AdminGetDevice * @see AWS API * Documentation */ java.util.concurrent.Future* Gets the specified user by user name in a user pool as an administrator. Works on any user. *
** Calling this action requires developer credentials. *
* * @param adminGetUserRequest * Represents the request to get the specified user as an administrator. * @return A Java Future containing the result of the AdminGetUser operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.AdminGetUser * @see AWS API * Documentation */ java.util.concurrent.Future* Gets the specified user by user name in a user pool as an administrator. Works on any user. *
** Calling this action requires developer credentials. *
* * @param adminGetUserRequest * Represents the request to get the specified user as an administrator. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the AdminGetUser operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.AdminGetUser * @see AWS API * Documentation */ java.util.concurrent.Future* Initiates the authentication flow, as an administrator. *
** This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to * register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text * messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered * number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, * activate their accounts, or sign in. *
** If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple * Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send * messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move * out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. *
** Calling this action requires developer credentials. *
* * @param adminInitiateAuthRequest * Initiates the authorization request, as an administrator. * @return A Java Future containing the result of the AdminInitiateAuth operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.AdminInitiateAuth * @see AWS * API Documentation */ java.util.concurrent.Future* Initiates the authentication flow, as an administrator. *
** This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to * register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text * messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered * number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, * activate their accounts, or sign in. *
** If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple * Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send * messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move * out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. *
** Calling this action requires developer credentials. *
* * @param adminInitiateAuthRequest * Initiates the authorization request, as an administrator. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the AdminInitiateAuth operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.AdminInitiateAuth * @see AWS * API Documentation */ java.util.concurrent.Future
* Links an existing user account in a user pool (DestinationUser) to an identity from an external IdP
* (SourceUser) based on a specified attribute name and value from the external IdP. This allows you to
* create a link from the existing user account to an external federated user identity that has not yet been used to
* sign in. You can then use the federated user identity to sign in as the existing user account.
*
* For example, if there is an existing user with a username and password, this API links that user to a federated * user identity. When the user signs in with a federated user identity, they sign in as the existing user account. *
** The maximum number of federated identities linked to a user is five. *
** Because this API allows a user with an external federated identity to sign in as an existing user in the user * pool, it is critical that it only be used with external IdPs and provider attributes that have been trusted by * the application owner. *
** This action is administrative and requires developer credentials. *
* * @param adminLinkProviderForUserRequest * @return A Java Future containing the result of the AdminLinkProviderForUser operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.AdminLinkProviderForUser * @see AWS API Documentation */ java.util.concurrent.Future
* Links an existing user account in a user pool (DestinationUser) to an identity from an external IdP
* (SourceUser) based on a specified attribute name and value from the external IdP. This allows you to
* create a link from the existing user account to an external federated user identity that has not yet been used to
* sign in. You can then use the federated user identity to sign in as the existing user account.
*
* For example, if there is an existing user with a username and password, this API links that user to a federated * user identity. When the user signs in with a federated user identity, they sign in as the existing user account. *
** The maximum number of federated identities linked to a user is five. *
** Because this API allows a user with an external federated identity to sign in as an existing user in the user * pool, it is critical that it only be used with external IdPs and provider attributes that have been trusted by * the application owner. *
** This action is administrative and requires developer credentials. *
* * @param adminLinkProviderForUserRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the AdminLinkProviderForUser operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.AdminLinkProviderForUser * @see AWS API Documentation */ java.util.concurrent.Future* Lists devices, as an administrator. *
** Calling this action requires developer credentials. *
* * @param adminListDevicesRequest * Represents the request to list devices, as an administrator. * @return A Java Future containing the result of the AdminListDevices operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.AdminListDevices * @see AWS * API Documentation */ java.util.concurrent.Future* Lists devices, as an administrator. *
** Calling this action requires developer credentials. *
* * @param adminListDevicesRequest * Represents the request to list devices, as an administrator. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the AdminListDevices operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.AdminListDevices * @see AWS * API Documentation */ java.util.concurrent.Future* Lists the groups that the user belongs to. *
** Calling this action requires developer credentials. *
* * @param adminListGroupsForUserRequest * @return A Java Future containing the result of the AdminListGroupsForUser operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.AdminListGroupsForUser * @see AWS API Documentation */ java.util.concurrent.Future* Lists the groups that the user belongs to. *
** Calling this action requires developer credentials. *
* * @param adminListGroupsForUserRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the AdminListGroupsForUser operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.AdminListGroupsForUser * @see AWS API Documentation */ java.util.concurrent.Future* A history of user activity and any risks detected as part of Amazon Cognito advanced security. *
* * @param adminListUserAuthEventsRequest * @return A Java Future containing the result of the AdminListUserAuthEvents operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.AdminListUserAuthEvents * @see AWS API Documentation */ java.util.concurrent.Future* A history of user activity and any risks detected as part of Amazon Cognito advanced security. *
* * @param adminListUserAuthEventsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the AdminListUserAuthEvents operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.AdminListUserAuthEvents * @see AWS API Documentation */ java.util.concurrent.Future* Removes the specified user from the specified group. *
** Calling this action requires developer credentials. *
* * @param adminRemoveUserFromGroupRequest * @return A Java Future containing the result of the AdminRemoveUserFromGroup operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.AdminRemoveUserFromGroup * @see AWS API Documentation */ java.util.concurrent.Future* Removes the specified user from the specified group. *
** Calling this action requires developer credentials. *
* * @param adminRemoveUserFromGroupRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the AdminRemoveUserFromGroup operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.AdminRemoveUserFromGroup * @see AWS API Documentation */ java.util.concurrent.Future* Resets the specified user's password in a user pool as an administrator. Works on any user. *
** When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to * sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should * direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, * if the user pool has phone verification selected and a verified phone number exists for the user, or if email * verification is selected and a verified email exists for the user, calling this API will also result in sending a * message to the end user with the code to change their password. *
** This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to * register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text * messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered * number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, * activate their accounts, or sign in. *
** If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple * Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send * messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move * out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. *
** Calling this action requires developer credentials. *
* * @param adminResetUserPasswordRequest * Represents the request to reset a user's password as an administrator. * @return A Java Future containing the result of the AdminResetUserPassword operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.AdminResetUserPassword * @see AWS API Documentation */ java.util.concurrent.Future* Resets the specified user's password in a user pool as an administrator. Works on any user. *
** When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to * sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should * direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, * if the user pool has phone verification selected and a verified phone number exists for the user, or if email * verification is selected and a verified email exists for the user, calling this API will also result in sending a * message to the end user with the code to change their password. *
** This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to * register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text * messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered * number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, * activate their accounts, or sign in. *
** If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple * Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send * messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move * out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. *
** Calling this action requires developer credentials. *
* * @param adminResetUserPasswordRequest * Represents the request to reset a user's password as an administrator. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the AdminResetUserPassword operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.AdminResetUserPassword * @see AWS API Documentation */ java.util.concurrent.Future* Responds to an authentication challenge, as an administrator. *
** This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to * register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text * messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered * number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, * activate their accounts, or sign in. *
** If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple * Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send * messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move * out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. *
** Calling this action requires developer credentials. *
* * @param adminRespondToAuthChallengeRequest * The request to respond to the authentication challenge, as an administrator. * @return A Java Future containing the result of the AdminRespondToAuthChallenge operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.AdminRespondToAuthChallenge * @see AWS API Documentation */ java.util.concurrent.Future* Responds to an authentication challenge, as an administrator. *
** This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to * register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text * messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered * number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, * activate their accounts, or sign in. *
** If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple * Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send * messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move * out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. *
** Calling this action requires developer credentials. *
* * @param adminRespondToAuthChallengeRequest * The request to respond to the authentication challenge, as an administrator. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the AdminRespondToAuthChallenge operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.AdminRespondToAuthChallenge * @see AWS API Documentation */ java.util.concurrent.Future* The user's multi-factor authentication (MFA) preference, including which MFA options are activated, and if any * are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a * user if multiple factors are activated. If multiple options are activated and no preference is set, a challenge * to choose an MFA option will be returned during sign-in. *
* * @param adminSetUserMFAPreferenceRequest * @return A Java Future containing the result of the AdminSetUserMFAPreference operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.AdminSetUserMFAPreference * @see AWS API Documentation */ java.util.concurrent.Future* The user's multi-factor authentication (MFA) preference, including which MFA options are activated, and if any * are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a * user if multiple factors are activated. If multiple options are activated and no preference is set, a challenge * to choose an MFA option will be returned during sign-in. *
* * @param adminSetUserMFAPreferenceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the AdminSetUserMFAPreference operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.AdminSetUserMFAPreference * @see AWS API Documentation */ java.util.concurrent.Future* Sets the specified user's password in a user pool as an administrator. Works on any user. *
*
* The password can be temporary or permanent. If it is temporary, the user status enters the
* FORCE_CHANGE_PASSWORD state. When the user next tries to sign in, the InitiateAuth/AdminInitiateAuth
* response will contain the NEW_PASSWORD_REQUIRED challenge. If the user doesn't sign in before it
* expires, the user won't be able to sign in, and an administrator must reset their password.
*
* Once the user has set a new password, or the password is permanent, the user status is set to
* Confirmed.
*
* Sets the specified user's password in a user pool as an administrator. Works on any user. *
*
* The password can be temporary or permanent. If it is temporary, the user status enters the
* FORCE_CHANGE_PASSWORD state. When the user next tries to sign in, the InitiateAuth/AdminInitiateAuth
* response will contain the NEW_PASSWORD_REQUIRED challenge. If the user doesn't sign in before it
* expires, the user won't be able to sign in, and an administrator must reset their password.
*
* Once the user has set a new password, or the password is permanent, the user status is set to
* Confirmed.
*
* This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to * configure time-based one-time password (TOTP) software token MFA. To configure either type of MFA, use AdminSetUserMFAPreference instead. *
* * @param adminSetUserSettingsRequest * You can use this parameter to set an MFA configuration that uses the SMS delivery medium. * @return A Java Future containing the result of the AdminSetUserSettings operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.AdminSetUserSettings * @see AWS API Documentation */ java.util.concurrent.Future* This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to * configure time-based one-time password (TOTP) software token MFA. To configure either type of MFA, use AdminSetUserMFAPreference instead. *
* * @param adminSetUserSettingsRequest * You can use this parameter to set an MFA configuration that uses the SMS delivery medium. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the AdminSetUserSettings operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.AdminSetUserSettings * @see AWS API Documentation */ java.util.concurrent.Future* Provides feedback for an authentication event indicating if it was from a valid user. This feedback is used for * improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security. *
* * @param adminUpdateAuthEventFeedbackRequest * @return A Java Future containing the result of the AdminUpdateAuthEventFeedback operation returned by the * service. * @sample AWSCognitoIdentityProviderAsync.AdminUpdateAuthEventFeedback * @see AWS API Documentation */ java.util.concurrent.Future* Provides feedback for an authentication event indicating if it was from a valid user. This feedback is used for * improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security. *
* * @param adminUpdateAuthEventFeedbackRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the AdminUpdateAuthEventFeedback operation returned by the * service. * @sample AWSCognitoIdentityProviderAsyncHandler.AdminUpdateAuthEventFeedback * @see AWS API Documentation */ java.util.concurrent.Future* Updates the device status as an administrator. *
** Calling this action requires developer credentials. *
* * @param adminUpdateDeviceStatusRequest * The request to update the device status, as an administrator. * @return A Java Future containing the result of the AdminUpdateDeviceStatus operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.AdminUpdateDeviceStatus * @see AWS API Documentation */ java.util.concurrent.Future* Updates the device status as an administrator. *
** Calling this action requires developer credentials. *
* * @param adminUpdateDeviceStatusRequest * The request to update the device status, as an administrator. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the AdminUpdateDeviceStatus operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.AdminUpdateDeviceStatus * @see AWS API Documentation */ java.util.concurrent.Future* Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user. *
*
* For custom attributes, you must prepend the custom: prefix to the attribute name.
*
* In addition to updating user attributes, this API can also be used to mark phone and email as verified. *
** This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to * register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text * messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered * number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, * activate their accounts, or sign in. *
** If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple * Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send * messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move * out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. *
** Calling this action requires developer credentials. *
* * @param adminUpdateUserAttributesRequest * Represents the request to update the user's attributes as an administrator. * @return A Java Future containing the result of the AdminUpdateUserAttributes operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.AdminUpdateUserAttributes * @see AWS API Documentation */ java.util.concurrent.Future* Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user. *
*
* For custom attributes, you must prepend the custom: prefix to the attribute name.
*
* In addition to updating user attributes, this API can also be used to mark phone and email as verified. *
** This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to * register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text * messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered * number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, * activate their accounts, or sign in. *
** If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple * Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send * messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move * out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. *
** Calling this action requires developer credentials. *
* * @param adminUpdateUserAttributesRequest * Represents the request to update the user's attributes as an administrator. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the AdminUpdateUserAttributes operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.AdminUpdateUserAttributes * @see AWS API Documentation */ java.util.concurrent.Future
* Signs out a user from all devices. You must sign AdminUserGlobalSignOut requests with Amazon Web
* Services credentials. It also invalidates all refresh tokens that Amazon Cognito has issued to a user. The user's
* current access and ID tokens remain valid until they expire. By default, access and ID tokens expire one hour
* after they're issued. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the
* cookie validity period of 1 hour.
*
* Calling this action requires developer credentials. *
* * @param adminUserGlobalSignOutRequest * The request to sign out of all devices, as an administrator. * @return A Java Future containing the result of the AdminUserGlobalSignOut operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.AdminUserGlobalSignOut * @see AWS API Documentation */ java.util.concurrent.Future
* Signs out a user from all devices. You must sign AdminUserGlobalSignOut requests with Amazon Web
* Services credentials. It also invalidates all refresh tokens that Amazon Cognito has issued to a user. The user's
* current access and ID tokens remain valid until they expire. By default, access and ID tokens expire one hour
* after they're issued. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the
* cookie validity period of 1 hour.
*
* Calling this action requires developer credentials. *
* * @param adminUserGlobalSignOutRequest * The request to sign out of all devices, as an administrator. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the AdminUserGlobalSignOut operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.AdminUserGlobalSignOut * @see AWS API Documentation */ java.util.concurrent.Future
* Begins setup of time-based one-time password (TOTP) multi-factor authentication (MFA) for a user, with a unique
* private key that Amazon Cognito generates and returns in the API response. You can authorize an
* AssociateSoftwareToken request with either the user's access token, or a session string from a
* challenge response that you received from Amazon Cognito.
*
* Amazon Cognito disassociates an existing software token when you verify the new token in a
* VerifySoftwareToken API request. If you don't verify the software token and your user pool doesn't require
* MFA, the user can then authenticate with user name and password credentials alone. If your user pool requires
* TOTP MFA, Amazon Cognito generates an MFA_SETUP or SOFTWARE_TOKEN_SETUP challenge each
* time your user signs. Complete setup with AssociateSoftwareToken and
* VerifySoftwareToken.
*
* After you set up software token MFA for your user, Amazon Cognito generates a SOFTWARE_TOKEN_MFA
* challenge when they authenticate. Respond to this challenge with your user's TOTP.
*
* Begins setup of time-based one-time password (TOTP) multi-factor authentication (MFA) for a user, with a unique
* private key that Amazon Cognito generates and returns in the API response. You can authorize an
* AssociateSoftwareToken request with either the user's access token, or a session string from a
* challenge response that you received from Amazon Cognito.
*
* Amazon Cognito disassociates an existing software token when you verify the new token in a
* VerifySoftwareToken API request. If you don't verify the software token and your user pool doesn't require
* MFA, the user can then authenticate with user name and password credentials alone. If your user pool requires
* TOTP MFA, Amazon Cognito generates an MFA_SETUP or SOFTWARE_TOKEN_SETUP challenge each
* time your user signs. Complete setup with AssociateSoftwareToken and
* VerifySoftwareToken.
*
* After you set up software token MFA for your user, Amazon Cognito generates a SOFTWARE_TOKEN_MFA
* challenge when they authenticate. Respond to this challenge with your user's TOTP.
*
* Changes the password for a specified user in a user pool. *
* * @param changePasswordRequest * Represents the request to change a user password. * @return A Java Future containing the result of the ChangePassword operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.ChangePassword * @see AWS API * Documentation */ java.util.concurrent.Future* Changes the password for a specified user in a user pool. *
* * @param changePasswordRequest * Represents the request to change a user password. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ChangePassword operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.ChangePassword * @see AWS API * Documentation */ java.util.concurrent.Future* Confirms tracking of the device. This API call is the call that begins device tracking. *
* * @param confirmDeviceRequest * Confirms the device request. * @return A Java Future containing the result of the ConfirmDevice operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.ConfirmDevice * @see AWS API * Documentation */ java.util.concurrent.Future* Confirms tracking of the device. This API call is the call that begins device tracking. *
* * @param confirmDeviceRequest * Confirms the device request. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ConfirmDevice operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.ConfirmDevice * @see AWS API * Documentation */ java.util.concurrent.Future* Allows a user to enter a confirmation code to reset a forgotten password. *
* * @param confirmForgotPasswordRequest * The request representing the confirmation for a password reset. * @return A Java Future containing the result of the ConfirmForgotPassword operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.ConfirmForgotPassword * @see AWS API Documentation */ java.util.concurrent.Future* Allows a user to enter a confirmation code to reset a forgotten password. *
* * @param confirmForgotPasswordRequest * The request representing the confirmation for a password reset. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ConfirmForgotPassword operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.ConfirmForgotPassword * @see AWS API Documentation */ java.util.concurrent.Future* Confirms registration of a new user. *
* * @param confirmSignUpRequest * Represents the request to confirm registration of a user. * @return A Java Future containing the result of the ConfirmSignUp operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.ConfirmSignUp * @see AWS API * Documentation */ java.util.concurrent.Future* Confirms registration of a new user. *
* * @param confirmSignUpRequest * Represents the request to confirm registration of a user. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ConfirmSignUp operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.ConfirmSignUp * @see AWS API * Documentation */ java.util.concurrent.Future* Creates a new group in the specified user pool. *
** Calling this action requires developer credentials. *
* * @param createGroupRequest * @return A Java Future containing the result of the CreateGroup operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.CreateGroup * @see AWS API * Documentation */ java.util.concurrent.Future* Creates a new group in the specified user pool. *
** Calling this action requires developer credentials. *
* * @param createGroupRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateGroup operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.CreateGroup * @see AWS API * Documentation */ java.util.concurrent.Future* Creates an IdP for a user pool. *
* * @param createIdentityProviderRequest * @return A Java Future containing the result of the CreateIdentityProvider operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.CreateIdentityProvider * @see AWS API Documentation */ java.util.concurrent.Future* Creates an IdP for a user pool. *
* * @param createIdentityProviderRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateIdentityProvider operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.CreateIdentityProvider * @see AWS API Documentation */ java.util.concurrent.Future* Creates a new OAuth2.0 resource server and defines custom scopes within it. *
* * @param createResourceServerRequest * @return A Java Future containing the result of the CreateResourceServer operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.CreateResourceServer * @see AWS API Documentation */ java.util.concurrent.Future* Creates a new OAuth2.0 resource server and defines custom scopes within it. *
* * @param createResourceServerRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateResourceServer operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.CreateResourceServer * @see AWS API Documentation */ java.util.concurrent.Future* Creates the user import job. *
* * @param createUserImportJobRequest * Represents the request to create the user import job. * @return A Java Future containing the result of the CreateUserImportJob operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.CreateUserImportJob * @see AWS API Documentation */ java.util.concurrent.Future* Creates the user import job. *
* * @param createUserImportJobRequest * Represents the request to create the user import job. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateUserImportJob operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.CreateUserImportJob * @see AWS API Documentation */ java.util.concurrent.Future* Creates a new Amazon Cognito user pool and sets the password policy for the pool. *
** This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to * register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text * messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered * number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, * activate their accounts, or sign in. *
** If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple * Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send * messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move * out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. *
** Creates a new Amazon Cognito user pool and sets the password policy for the pool. *
** This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to * register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text * messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered * number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, * activate their accounts, or sign in. *
** If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple * Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send * messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move * out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. *
** Creates the user pool client. *
** When you create a new user pool client, token revocation is automatically activated. For more information about * revoking tokens, see RevokeToken. *
* * @param createUserPoolClientRequest * Represents the request to create a user pool client. * @return A Java Future containing the result of the CreateUserPoolClient operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.CreateUserPoolClient * @see AWS API Documentation */ java.util.concurrent.Future* Creates the user pool client. *
** When you create a new user pool client, token revocation is automatically activated. For more information about * revoking tokens, see RevokeToken. *
* * @param createUserPoolClientRequest * Represents the request to create a user pool client. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateUserPoolClient operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.CreateUserPoolClient * @see AWS API Documentation */ java.util.concurrent.Future* Creates a new domain for a user pool. *
* * @param createUserPoolDomainRequest * @return A Java Future containing the result of the CreateUserPoolDomain operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.CreateUserPoolDomain * @see AWS API Documentation */ java.util.concurrent.Future* Creates a new domain for a user pool. *
* * @param createUserPoolDomainRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateUserPoolDomain operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.CreateUserPoolDomain * @see AWS API Documentation */ java.util.concurrent.Future* Deletes a group. *
** Calling this action requires developer credentials. *
* * @param deleteGroupRequest * @return A Java Future containing the result of the DeleteGroup operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.DeleteGroup * @see AWS API * Documentation */ java.util.concurrent.Future* Deletes a group. *
** Calling this action requires developer credentials. *
* * @param deleteGroupRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteGroup operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.DeleteGroup * @see AWS API * Documentation */ java.util.concurrent.Future* Deletes an IdP for a user pool. *
* * @param deleteIdentityProviderRequest * @return A Java Future containing the result of the DeleteIdentityProvider operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.DeleteIdentityProvider * @see AWS API Documentation */ java.util.concurrent.Future* Deletes an IdP for a user pool. *
* * @param deleteIdentityProviderRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteIdentityProvider operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.DeleteIdentityProvider * @see AWS API Documentation */ java.util.concurrent.Future* Deletes a resource server. *
* * @param deleteResourceServerRequest * @return A Java Future containing the result of the DeleteResourceServer operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.DeleteResourceServer * @see AWS API Documentation */ java.util.concurrent.Future* Deletes a resource server. *
* * @param deleteResourceServerRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteResourceServer operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.DeleteResourceServer * @see AWS API Documentation */ java.util.concurrent.Future* Allows a user to delete himself or herself. *
* * @param deleteUserRequest * Represents the request to delete a user. * @return A Java Future containing the result of the DeleteUser operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.DeleteUser * @see AWS API * Documentation */ java.util.concurrent.Future* Allows a user to delete himself or herself. *
* * @param deleteUserRequest * Represents the request to delete a user. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteUser operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.DeleteUser * @see AWS API * Documentation */ java.util.concurrent.Future* Deletes the attributes for a user. *
* * @param deleteUserAttributesRequest * Represents the request to delete user attributes. * @return A Java Future containing the result of the DeleteUserAttributes operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.DeleteUserAttributes * @see AWS API Documentation */ java.util.concurrent.Future* Deletes the attributes for a user. *
* * @param deleteUserAttributesRequest * Represents the request to delete user attributes. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteUserAttributes operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.DeleteUserAttributes * @see AWS API Documentation */ java.util.concurrent.Future* Deletes the specified Amazon Cognito user pool. *
* * @param deleteUserPoolRequest * Represents the request to delete a user pool. * @return A Java Future containing the result of the DeleteUserPool operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.DeleteUserPool * @see AWS API * Documentation */ java.util.concurrent.Future* Deletes the specified Amazon Cognito user pool. *
* * @param deleteUserPoolRequest * Represents the request to delete a user pool. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteUserPool operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.DeleteUserPool * @see AWS API * Documentation */ java.util.concurrent.Future* Allows the developer to delete the user pool client. *
* * @param deleteUserPoolClientRequest * Represents the request to delete a user pool client. * @return A Java Future containing the result of the DeleteUserPoolClient operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.DeleteUserPoolClient * @see AWS API Documentation */ java.util.concurrent.Future* Allows the developer to delete the user pool client. *
* * @param deleteUserPoolClientRequest * Represents the request to delete a user pool client. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteUserPoolClient operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.DeleteUserPoolClient * @see AWS API Documentation */ java.util.concurrent.Future* Deletes a domain for a user pool. *
* * @param deleteUserPoolDomainRequest * @return A Java Future containing the result of the DeleteUserPoolDomain operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.DeleteUserPoolDomain * @see AWS API Documentation */ java.util.concurrent.Future* Deletes a domain for a user pool. *
* * @param deleteUserPoolDomainRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteUserPoolDomain operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.DeleteUserPoolDomain * @see AWS API Documentation */ java.util.concurrent.Future* Gets information about a specific IdP. *
* * @param describeIdentityProviderRequest * @return A Java Future containing the result of the DescribeIdentityProvider operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.DescribeIdentityProvider * @see AWS API Documentation */ java.util.concurrent.Future* Gets information about a specific IdP. *
* * @param describeIdentityProviderRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeIdentityProvider operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.DescribeIdentityProvider * @see AWS API Documentation */ java.util.concurrent.Future* Describes a resource server. *
* * @param describeResourceServerRequest * @return A Java Future containing the result of the DescribeResourceServer operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.DescribeResourceServer * @see AWS API Documentation */ java.util.concurrent.Future* Describes a resource server. *
* * @param describeResourceServerRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeResourceServer operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.DescribeResourceServer * @see AWS API Documentation */ java.util.concurrent.Future* Describes the risk configuration. *
* * @param describeRiskConfigurationRequest * @return A Java Future containing the result of the DescribeRiskConfiguration operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.DescribeRiskConfiguration * @see AWS API Documentation */ java.util.concurrent.Future* Describes the risk configuration. *
* * @param describeRiskConfigurationRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeRiskConfiguration operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.DescribeRiskConfiguration * @see AWS API Documentation */ java.util.concurrent.Future* Describes the user import job. *
* * @param describeUserImportJobRequest * Represents the request to describe the user import job. * @return A Java Future containing the result of the DescribeUserImportJob operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.DescribeUserImportJob * @see AWS API Documentation */ java.util.concurrent.Future* Describes the user import job. *
* * @param describeUserImportJobRequest * Represents the request to describe the user import job. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeUserImportJob operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.DescribeUserImportJob * @see AWS API Documentation */ java.util.concurrent.Future* Returns the configuration information and metadata of the specified user pool. *
* * @param describeUserPoolRequest * Represents the request to describe the user pool. * @return A Java Future containing the result of the DescribeUserPool operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.DescribeUserPool * @see AWS * API Documentation */ java.util.concurrent.Future* Returns the configuration information and metadata of the specified user pool. *
* * @param describeUserPoolRequest * Represents the request to describe the user pool. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeUserPool operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.DescribeUserPool * @see AWS * API Documentation */ java.util.concurrent.Future* Client method for returning the configuration information and metadata of the specified user pool app client. *
* * @param describeUserPoolClientRequest * Represents the request to describe a user pool client. * @return A Java Future containing the result of the DescribeUserPoolClient operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.DescribeUserPoolClient * @see AWS API Documentation */ java.util.concurrent.Future* Client method for returning the configuration information and metadata of the specified user pool app client. *
* * @param describeUserPoolClientRequest * Represents the request to describe a user pool client. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeUserPoolClient operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.DescribeUserPoolClient * @see AWS API Documentation */ java.util.concurrent.Future* Gets information about a domain. *
* * @param describeUserPoolDomainRequest * @return A Java Future containing the result of the DescribeUserPoolDomain operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.DescribeUserPoolDomain * @see AWS API Documentation */ java.util.concurrent.Future* Gets information about a domain. *
* * @param describeUserPoolDomainRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeUserPoolDomain operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.DescribeUserPoolDomain * @see AWS API Documentation */ java.util.concurrent.Future* Forgets the specified device. *
* * @param forgetDeviceRequest * Represents the request to forget the device. * @return A Java Future containing the result of the ForgetDevice operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.ForgetDevice * @see AWS API * Documentation */ java.util.concurrent.Future* Forgets the specified device. *
* * @param forgetDeviceRequest * Represents the request to forget the device. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ForgetDevice operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.ForgetDevice * @see AWS API * Documentation */ java.util.concurrent.Future
* Calling this API causes a message to be sent to the end user with a confirmation code that is required to change
* the user's password. For the Username parameter, you can use the username or user alias. The method
* used to send the confirmation code is sent according to the specified AccountRecoverySetting. For more
* information, see Recovering
* User Accounts in the Amazon Cognito Developer Guide. If neither a verified phone number nor a verified
* email exists, an InvalidParameterException is thrown. To use the confirmation code for resetting the
* password, call ConfirmForgotPassword.
*
* This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to * register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text * messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered * number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, * activate their accounts, or sign in. *
** If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple * Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send * messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move * out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. *
*
* Calling this API causes a message to be sent to the end user with a confirmation code that is required to change
* the user's password. For the Username parameter, you can use the username or user alias. The method
* used to send the confirmation code is sent according to the specified AccountRecoverySetting. For more
* information, see Recovering
* User Accounts in the Amazon Cognito Developer Guide. If neither a verified phone number nor a verified
* email exists, an InvalidParameterException is thrown. To use the confirmation code for resetting the
* password, call ConfirmForgotPassword.
*
* This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to * register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text * messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered * number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, * activate their accounts, or sign in. *
** If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple * Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send * messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move * out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. *
** Gets the header information for the comma-separated value (CSV) file to be used as input for the user import job. *
* * @param getCSVHeaderRequest * Represents the request to get the header information of the CSV file for the user import job. * @return A Java Future containing the result of the GetCSVHeader operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.GetCSVHeader * @see AWS API * Documentation */ java.util.concurrent.Future* Gets the header information for the comma-separated value (CSV) file to be used as input for the user import job. *
* * @param getCSVHeaderRequest * Represents the request to get the header information of the CSV file for the user import job. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetCSVHeader operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.GetCSVHeader * @see AWS API * Documentation */ java.util.concurrent.Future* Gets the device. *
* * @param getDeviceRequest * Represents the request to get the device. * @return A Java Future containing the result of the GetDevice operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.GetDevice * @see AWS API * Documentation */ java.util.concurrent.Future* Gets the device. *
* * @param getDeviceRequest * Represents the request to get the device. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetDevice operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.GetDevice * @see AWS API * Documentation */ java.util.concurrent.Future* Gets a group. *
** Calling this action requires developer credentials. *
* * @param getGroupRequest * @return A Java Future containing the result of the GetGroup operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.GetGroup * @see AWS API * Documentation */ java.util.concurrent.Future* Gets a group. *
** Calling this action requires developer credentials. *
* * @param getGroupRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetGroup operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.GetGroup * @see AWS API * Documentation */ java.util.concurrent.Future* Gets the specified IdP. *
* * @param getIdentityProviderByIdentifierRequest * @return A Java Future containing the result of the GetIdentityProviderByIdentifier operation returned by the * service. * @sample AWSCognitoIdentityProviderAsync.GetIdentityProviderByIdentifier * @see AWS API Documentation */ java.util.concurrent.Future* Gets the specified IdP. *
* * @param getIdentityProviderByIdentifierRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetIdentityProviderByIdentifier operation returned by the * service. * @sample AWSCognitoIdentityProviderAsyncHandler.GetIdentityProviderByIdentifier * @see AWS API Documentation */ java.util.concurrent.Future* This method takes a user pool ID, and returns the signing certificate. The issued certificate is valid for 10 * years from the date of issue. *
*
* Amazon Cognito issues and assigns a new signing certificate annually. This process returns a new value in the
* response to GetSigningCertificate, but doesn't invalidate the original certificate.
*
* This method takes a user pool ID, and returns the signing certificate. The issued certificate is valid for 10 * years from the date of issue. *
*
* Amazon Cognito issues and assigns a new signing certificate annually. This process returns a new value in the
* response to GetSigningCertificate, but doesn't invalidate the original certificate.
*
* Gets the user interface (UI) Customization information for a particular app client's app UI, if any such
* information exists for the client. If nothing is set for the particular client, but there is an existing pool
* level customization (the app clientId is ALL), then that information is returned. If
* nothing is present, then an empty shape is returned.
*
* Gets the user interface (UI) Customization information for a particular app client's app UI, if any such
* information exists for the client. If nothing is set for the particular client, but there is an existing pool
* level customization (the app clientId is ALL), then that information is returned. If
* nothing is present, then an empty shape is returned.
*
* Gets the user attributes and metadata for a user. *
* * @param getUserRequest * Represents the request to get information about the user. * @return A Java Future containing the result of the GetUser operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.GetUser * @see AWS API * Documentation */ java.util.concurrent.Future* Gets the user attributes and metadata for a user. *
* * @param getUserRequest * Represents the request to get information about the user. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetUser operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.GetUser * @see AWS API * Documentation */ java.util.concurrent.Future* Generates a user attribute verification code for the specified attribute name. Sends a message to a user with a * code that they must return in a VerifyUserAttribute request. *
** This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to * register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text * messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered * number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, * activate their accounts, or sign in. *
** If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple * Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send * messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move * out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. *
** Generates a user attribute verification code for the specified attribute name. Sends a message to a user with a * code that they must return in a VerifyUserAttribute request. *
** This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to * register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text * messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered * number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, * activate their accounts, or sign in. *
** If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple * Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send * messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move * out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. *
** Gets the user pool multi-factor authentication (MFA) configuration. *
* * @param getUserPoolMfaConfigRequest * @return A Java Future containing the result of the GetUserPoolMfaConfig operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.GetUserPoolMfaConfig * @see AWS API Documentation */ java.util.concurrent.Future* Gets the user pool multi-factor authentication (MFA) configuration. *
* * @param getUserPoolMfaConfigRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetUserPoolMfaConfig operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.GetUserPoolMfaConfig * @see AWS API Documentation */ java.util.concurrent.Future* Signs out users from all devices. It also invalidates all refresh tokens that Amazon Cognito has issued to a * user. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the 1-hour cookie * validity period. *
* * @param globalSignOutRequest * Represents the request to sign out all devices. * @return A Java Future containing the result of the GlobalSignOut operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.GlobalSignOut * @see AWS API * Documentation */ java.util.concurrent.Future* Signs out users from all devices. It also invalidates all refresh tokens that Amazon Cognito has issued to a * user. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the 1-hour cookie * validity period. *
* * @param globalSignOutRequest * Represents the request to sign out all devices. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GlobalSignOut operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.GlobalSignOut * @see AWS API * Documentation */ java.util.concurrent.Future
* Initiates sign-in for a user in the Amazon Cognito user directory. You can't sign in a user with a federated IdP
* with InitiateAuth. For more information, see
* Adding user pool sign-in through a third party.
*
* This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to * register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text * messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered * number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, * activate their accounts, or sign in. *
** If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple * Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send * messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move * out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. *
*
* Initiates sign-in for a user in the Amazon Cognito user directory. You can't sign in a user with a federated IdP
* with InitiateAuth. For more information, see
* Adding user pool sign-in through a third party.
*
* This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to * register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text * messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered * number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, * activate their accounts, or sign in. *
** If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple * Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send * messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move * out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. *
** Lists the sign-in devices that Amazon Cognito has registered to the current user. *
* * @param listDevicesRequest * Represents the request to list the devices. * @return A Java Future containing the result of the ListDevices operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.ListDevices * @see AWS API * Documentation */ java.util.concurrent.Future* Lists the sign-in devices that Amazon Cognito has registered to the current user. *
* * @param listDevicesRequest * Represents the request to list the devices. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListDevices operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.ListDevices * @see AWS API * Documentation */ java.util.concurrent.Future* Lists the groups associated with a user pool. *
** Calling this action requires developer credentials. *
* * @param listGroupsRequest * @return A Java Future containing the result of the ListGroups operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.ListGroups * @see AWS API * Documentation */ java.util.concurrent.Future* Lists the groups associated with a user pool. *
** Calling this action requires developer credentials. *
* * @param listGroupsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListGroups operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.ListGroups * @see AWS API * Documentation */ java.util.concurrent.Future* Lists information about all IdPs for a user pool. *
* * @param listIdentityProvidersRequest * @return A Java Future containing the result of the ListIdentityProviders operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.ListIdentityProviders * @see AWS API Documentation */ java.util.concurrent.Future* Lists information about all IdPs for a user pool. *
* * @param listIdentityProvidersRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListIdentityProviders operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.ListIdentityProviders * @see AWS API Documentation */ java.util.concurrent.Future* Lists the resource servers for a user pool. *
* * @param listResourceServersRequest * @return A Java Future containing the result of the ListResourceServers operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.ListResourceServers * @see AWS API Documentation */ java.util.concurrent.Future* Lists the resource servers for a user pool. *
* * @param listResourceServersRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListResourceServers operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.ListResourceServers * @see AWS API Documentation */ java.util.concurrent.Future* Lists the tags that are assigned to an Amazon Cognito user pool. *
** A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by * purpose, owner, environment, or other criteria. *
** You can use this action up to 10 times per second, per account. *
* * @param listTagsForResourceRequest * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.ListTagsForResource * @see AWS API Documentation */ java.util.concurrent.Future* Lists the tags that are assigned to an Amazon Cognito user pool. *
** A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by * purpose, owner, environment, or other criteria. *
** You can use this action up to 10 times per second, per account. *
* * @param listTagsForResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.ListTagsForResource * @see AWS API Documentation */ java.util.concurrent.Future* Lists the user import jobs. *
* * @param listUserImportJobsRequest * Represents the request to list the user import jobs. * @return A Java Future containing the result of the ListUserImportJobs operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.ListUserImportJobs * @see AWS * API Documentation */ java.util.concurrent.Future* Lists the user import jobs. *
* * @param listUserImportJobsRequest * Represents the request to list the user import jobs. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListUserImportJobs operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.ListUserImportJobs * @see AWS * API Documentation */ java.util.concurrent.Future* Lists the clients that have been created for the specified user pool. *
* * @param listUserPoolClientsRequest * Represents the request to list the user pool clients. * @return A Java Future containing the result of the ListUserPoolClients operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.ListUserPoolClients * @see AWS API Documentation */ java.util.concurrent.Future* Lists the clients that have been created for the specified user pool. *
* * @param listUserPoolClientsRequest * Represents the request to list the user pool clients. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListUserPoolClients operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.ListUserPoolClients * @see AWS API Documentation */ java.util.concurrent.Future* Lists the user pools associated with an Amazon Web Services account. *
* * @param listUserPoolsRequest * Represents the request to list user pools. * @return A Java Future containing the result of the ListUserPools operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.ListUserPools * @see AWS API * Documentation */ java.util.concurrent.Future* Lists the user pools associated with an Amazon Web Services account. *
* * @param listUserPoolsRequest * Represents the request to list user pools. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListUserPools operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.ListUserPools * @see AWS API * Documentation */ java.util.concurrent.Future* Lists the users in the Amazon Cognito user pool. *
* * @param listUsersRequest * Represents the request to list users. * @return A Java Future containing the result of the ListUsers operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.ListUsers * @see AWS API * Documentation */ java.util.concurrent.Future* Lists the users in the Amazon Cognito user pool. *
* * @param listUsersRequest * Represents the request to list users. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListUsers operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.ListUsers * @see AWS API * Documentation */ java.util.concurrent.Future* Lists the users in the specified group. *
** Calling this action requires developer credentials. *
* * @param listUsersInGroupRequest * @return A Java Future containing the result of the ListUsersInGroup operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.ListUsersInGroup * @see AWS * API Documentation */ java.util.concurrent.Future* Lists the users in the specified group. *
** Calling this action requires developer credentials. *
* * @param listUsersInGroupRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListUsersInGroup operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.ListUsersInGroup * @see AWS * API Documentation */ java.util.concurrent.Future* Resends the confirmation (for confirmation of registration) to a specific user in the user pool. *
** This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to * register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text * messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered * number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, * activate their accounts, or sign in. *
** If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple * Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send * messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move * out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. *
** Resends the confirmation (for confirmation of registration) to a specific user in the user pool. *
** This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to * register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text * messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered * number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, * activate their accounts, or sign in. *
** If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple * Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send * messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move * out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. *
** Responds to the authentication challenge. *
** This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to * register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text * messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered * number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, * activate their accounts, or sign in. *
** If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple * Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send * messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move * out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. *
** Responds to the authentication challenge. *
** This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to * register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text * messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered * number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, * activate their accounts, or sign in. *
** If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple * Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send * messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move * out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. *
** Revokes all of the access tokens generated by, and at the same time as, the specified refresh token. After a * token is revoked, you can't use the revoked token to access Amazon Cognito user APIs, or to authorize access to * your resource server. *
* * @param revokeTokenRequest * @return A Java Future containing the result of the RevokeToken operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.RevokeToken * @see AWS API * Documentation */ java.util.concurrent.Future* Revokes all of the access tokens generated by, and at the same time as, the specified refresh token. After a * token is revoked, you can't use the revoked token to access Amazon Cognito user APIs, or to authorize access to * your resource server. *
* * @param revokeTokenRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the RevokeToken operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.RevokeToken * @see AWS API * Documentation */ java.util.concurrent.Future
* Configures actions on detected risks. To delete the risk configuration for UserPoolId or
* ClientId, pass null values for all four configuration types.
*
* To activate Amazon Cognito advanced security features, update the user pool to include the
* UserPoolAddOns keyAdvancedSecurityMode.
*
* Configures actions on detected risks. To delete the risk configuration for UserPoolId or
* ClientId, pass null values for all four configuration types.
*
* To activate Amazon Cognito advanced security features, update the user pool to include the
* UserPoolAddOns keyAdvancedSecurityMode.
*
* Sets the user interface (UI) customization information for a user pool's built-in app UI. *
*
* You can specify app UI customization settings for a single client (with a specific clientId) or for
* all clients (by setting the clientId to ALL). If you specify ALL, the
* default configuration is used for every client that has no previously set UI customization. If you specify UI
* customization settings for a particular client, it will no longer return to the ALL configuration.
*
* To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the * app's pages, and the service will throw an error. *
** Sets the user interface (UI) customization information for a user pool's built-in app UI. *
*
* You can specify app UI customization settings for a single client (with a specific clientId) or for
* all clients (by setting the clientId to ALL). If you specify ALL, the
* default configuration is used for every client that has no previously set UI customization. If you specify UI
* customization settings for a particular client, it will no longer return to the ALL configuration.
*
* To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the * app's pages, and the service will throw an error. *
** Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are activated and * if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to * authenticate a user if multiple factors are activated. If multiple options are activated and no preference is * set, a challenge to choose an MFA option will be returned during sign-in. If an MFA type is activated for a user, * the user will be prompted for MFA during all sign-in attempts unless device tracking is turned on and the device * has been trusted. If you want MFA to be applied selectively based on the assessed risk level of sign-in attempts, * deactivate MFA for users and turn on Adaptive Authentication for the user pool. *
* * @param setUserMFAPreferenceRequest * @return A Java Future containing the result of the SetUserMFAPreference operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.SetUserMFAPreference * @see AWS API Documentation */ java.util.concurrent.Future* Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are activated and * if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to * authenticate a user if multiple factors are activated. If multiple options are activated and no preference is * set, a challenge to choose an MFA option will be returned during sign-in. If an MFA type is activated for a user, * the user will be prompted for MFA during all sign-in attempts unless device tracking is turned on and the device * has been trusted. If you want MFA to be applied selectively based on the assessed risk level of sign-in attempts, * deactivate MFA for users and turn on Adaptive Authentication for the user pool. *
* * @param setUserMFAPreferenceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the SetUserMFAPreference operation returned by the service. * @sample AWSCognitoIdentityProviderAsyncHandler.SetUserMFAPreference * @see AWS API Documentation */ java.util.concurrent.Future* Sets the user pool multi-factor authentication (MFA) configuration. *
** This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to * register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text * messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered * number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, * activate their accounts, or sign in. *
** If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple * Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send * messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move * out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. *
** Sets the user pool multi-factor authentication (MFA) configuration. *
** This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to * register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text * messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered * number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, * activate their accounts, or sign in. *
** If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple * Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send * messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move * out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide. *
** This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to * configure time-based one-time password (TOTP) software token MFA. To configure either type of MFA, use SetUserMFAPreference instead. *
* * @param setUserSettingsRequest * Represents the request to set user settings. * @return A Java Future containing the result of the SetUserSettings operation returned by the service. * @sample AWSCognitoIdentityProviderAsync.SetUserSettings * @see AWS * API Documentation */ java.util.concurrent.Future*