Interface AWSCognitoIdentityProviderAsync
- All Superinterfaces:
AWSCognitoIdentityProvider
- All Known Implementing Classes:
AbstractAWSCognitoIdentityProviderAsync
,AWSCognitoIdentityProviderAsyncClient
AsyncHandler
can be
used to receive notification when an asynchronous operation completes.
You can create a user pool in Amazon Cognito Identity 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 Identity, which is a new capability that is available as a beta.
-
Method Summary
Modifier and TypeMethodDescriptionaddCustomAttributesAsync
(AddCustomAttributesRequest addCustomAttributesRequest) Adds additional user attributes to the user pool schema.addCustomAttributesAsync
(AddCustomAttributesRequest addCustomAttributesRequest, AsyncHandler<AddCustomAttributesRequest, AddCustomAttributesResult> asyncHandler) Adds additional user attributes to the user pool schema.adminConfirmSignUpAsync
(AdminConfirmSignUpRequest adminConfirmSignUpRequest) Confirms user registration as an admin without using a confirmation code.adminConfirmSignUpAsync
(AdminConfirmSignUpRequest adminConfirmSignUpRequest, AsyncHandler<AdminConfirmSignUpRequest, AdminConfirmSignUpResult> asyncHandler) Confirms user registration as an admin without using a confirmation code.adminDeleteUserAsync
(AdminDeleteUserRequest adminDeleteUserRequest) Deletes a user as an administrator.adminDeleteUserAsync
(AdminDeleteUserRequest adminDeleteUserRequest, AsyncHandler<AdminDeleteUserRequest, AdminDeleteUserResult> asyncHandler) Deletes a user as an administrator.adminDeleteUserAttributesAsync
(AdminDeleteUserAttributesRequest adminDeleteUserAttributesRequest) Deletes the user attributes in a user pool as an administrator.adminDeleteUserAttributesAsync
(AdminDeleteUserAttributesRequest adminDeleteUserAttributesRequest, AsyncHandler<AdminDeleteUserAttributesRequest, AdminDeleteUserAttributesResult> asyncHandler) Deletes the user attributes in a user pool as an administrator.adminDisableUserAsync
(AdminDisableUserRequest adminDisableUserRequest) Disables the specified user as an administrator.adminDisableUserAsync
(AdminDisableUserRequest adminDisableUserRequest, AsyncHandler<AdminDisableUserRequest, AdminDisableUserResult> asyncHandler) Disables the specified user as an administrator.adminEnableUserAsync
(AdminEnableUserRequest adminEnableUserRequest) Enables the specified user as an administrator.adminEnableUserAsync
(AdminEnableUserRequest adminEnableUserRequest, AsyncHandler<AdminEnableUserRequest, AdminEnableUserResult> asyncHandler) Enables the specified user as an administrator.adminGetUserAsync
(AdminGetUserRequest adminGetUserRequest) Gets the specified user by user name in a user pool as an administrator.adminGetUserAsync
(AdminGetUserRequest adminGetUserRequest, AsyncHandler<AdminGetUserRequest, AdminGetUserResult> asyncHandler) Gets the specified user by user name in a user pool as an administrator.adminResetUserPasswordAsync
(AdminResetUserPasswordRequest adminResetUserPasswordRequest) Resets the specified user's password in a user pool as an administrator.adminResetUserPasswordAsync
(AdminResetUserPasswordRequest adminResetUserPasswordRequest, AsyncHandler<AdminResetUserPasswordRequest, AdminResetUserPasswordResult> asyncHandler) Resets the specified user's password in a user pool as an administrator.adminSetUserSettingsAsync
(AdminSetUserSettingsRequest adminSetUserSettingsRequest) Sets all the user settings for a specified user name.adminSetUserSettingsAsync
(AdminSetUserSettingsRequest adminSetUserSettingsRequest, AsyncHandler<AdminSetUserSettingsRequest, AdminSetUserSettingsResult> asyncHandler) Sets all the user settings for a specified user name.adminUpdateUserAttributesAsync
(AdminUpdateUserAttributesRequest adminUpdateUserAttributesRequest) Updates the specified user's attributes, including developer attributes, as an administrator.adminUpdateUserAttributesAsync
(AdminUpdateUserAttributesRequest adminUpdateUserAttributesRequest, AsyncHandler<AdminUpdateUserAttributesRequest, AdminUpdateUserAttributesResult> asyncHandler) Updates the specified user's attributes, including developer attributes, as an administrator.changePasswordAsync
(ChangePasswordRequest changePasswordRequest) Changes the password for a specified user in a user pool.changePasswordAsync
(ChangePasswordRequest changePasswordRequest, AsyncHandler<ChangePasswordRequest, ChangePasswordResult> asyncHandler) Changes the password for a specified user in a user pool.confirmForgotPasswordAsync
(ConfirmForgotPasswordRequest confirmForgotPasswordRequest) Allows a user to enter a code provided when they reset their password to update their password.confirmForgotPasswordAsync
(ConfirmForgotPasswordRequest confirmForgotPasswordRequest, AsyncHandler<ConfirmForgotPasswordRequest, ConfirmForgotPasswordResult> asyncHandler) Allows a user to enter a code provided when they reset their password to update their password.confirmSignUpAsync
(ConfirmSignUpRequest confirmSignUpRequest) Confirms registration of a user and handles the existing alias from a previous user.confirmSignUpAsync
(ConfirmSignUpRequest confirmSignUpRequest, AsyncHandler<ConfirmSignUpRequest, ConfirmSignUpResult> asyncHandler) Confirms registration of a user and handles the existing alias from a previous user.createUserPoolAsync
(CreateUserPoolRequest createUserPoolRequest) Creates a new Amazon Cognito user pool and sets the password policy for the pool.createUserPoolAsync
(CreateUserPoolRequest createUserPoolRequest, AsyncHandler<CreateUserPoolRequest, CreateUserPoolResult> asyncHandler) Creates a new Amazon Cognito user pool and sets the password policy for the pool.createUserPoolClientAsync
(CreateUserPoolClientRequest createUserPoolClientRequest) Creates the user pool client.createUserPoolClientAsync
(CreateUserPoolClientRequest createUserPoolClientRequest, AsyncHandler<CreateUserPoolClientRequest, CreateUserPoolClientResult> asyncHandler) Creates the user pool client.deleteUserAsync
(DeleteUserRequest deleteUserRequest) Allows a user to delete one's self.deleteUserAsync
(DeleteUserRequest deleteUserRequest, AsyncHandler<DeleteUserRequest, DeleteUserResult> asyncHandler) Allows a user to delete one's self.deleteUserAttributesAsync
(DeleteUserAttributesRequest deleteUserAttributesRequest) Deletes the attributes for a user.deleteUserAttributesAsync
(DeleteUserAttributesRequest deleteUserAttributesRequest, AsyncHandler<DeleteUserAttributesRequest, DeleteUserAttributesResult> asyncHandler) Deletes the attributes for a user.deleteUserPoolAsync
(DeleteUserPoolRequest deleteUserPoolRequest) Deletes the specified Amazon Cognito user pool.deleteUserPoolAsync
(DeleteUserPoolRequest deleteUserPoolRequest, AsyncHandler<DeleteUserPoolRequest, DeleteUserPoolResult> asyncHandler) Deletes the specified Amazon Cognito user pool.deleteUserPoolClientAsync
(DeleteUserPoolClientRequest deleteUserPoolClientRequest) Allows the developer to delete the user pool client.deleteUserPoolClientAsync
(DeleteUserPoolClientRequest deleteUserPoolClientRequest, AsyncHandler<DeleteUserPoolClientRequest, DeleteUserPoolClientResult> asyncHandler) Allows the developer to delete the user pool client.describeUserPoolAsync
(DescribeUserPoolRequest describeUserPoolRequest) Returns the configuration information and metadata of the specified user pool.describeUserPoolAsync
(DescribeUserPoolRequest describeUserPoolRequest, AsyncHandler<DescribeUserPoolRequest, DescribeUserPoolResult> asyncHandler) Returns the configuration information and metadata of the specified user pool.describeUserPoolClientAsync
(DescribeUserPoolClientRequest describeUserPoolClientRequest) Client method for returning the configuration information and metadata of the specified user pool client.describeUserPoolClientAsync
(DescribeUserPoolClientRequest describeUserPoolClientRequest, AsyncHandler<DescribeUserPoolClientRequest, DescribeUserPoolClientResult> asyncHandler) Client method for returning the configuration information and metadata of the specified user pool client.forgotPasswordAsync
(ForgotPasswordRequest forgotPasswordRequest) Retrieves the password for the specified client ID or username.forgotPasswordAsync
(ForgotPasswordRequest forgotPasswordRequest, AsyncHandler<ForgotPasswordRequest, ForgotPasswordResult> asyncHandler) Retrieves the password for the specified client ID or username.getUserAsync
(GetUserRequest getUserRequest) Gets the user attributes and metadata for a user.getUserAsync
(GetUserRequest getUserRequest, AsyncHandler<GetUserRequest, GetUserResult> asyncHandler) Gets the user attributes and metadata for a user.getUserAttributeVerificationCodeAsync
(GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest) Gets the user attribute verification code for the specified attribute name.getUserAttributeVerificationCodeAsync
(GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest, AsyncHandler<GetUserAttributeVerificationCodeRequest, GetUserAttributeVerificationCodeResult> asyncHandler) Gets the user attribute verification code for the specified attribute name.listUserPoolClientsAsync
(ListUserPoolClientsRequest listUserPoolClientsRequest) Lists the clients that have been created for the specified user pool.listUserPoolClientsAsync
(ListUserPoolClientsRequest listUserPoolClientsRequest, AsyncHandler<ListUserPoolClientsRequest, ListUserPoolClientsResult> asyncHandler) Lists the clients that have been created for the specified user pool.listUserPoolsAsync
(ListUserPoolsRequest listUserPoolsRequest) Lists the user pools associated with an AWS account.listUserPoolsAsync
(ListUserPoolsRequest listUserPoolsRequest, AsyncHandler<ListUserPoolsRequest, ListUserPoolsResult> asyncHandler) Lists the user pools associated with an AWS account.listUsersAsync
(ListUsersRequest listUsersRequest) Lists the users in the Amazon Cognito user pool.listUsersAsync
(ListUsersRequest listUsersRequest, AsyncHandler<ListUsersRequest, ListUsersResult> asyncHandler) Lists the users in the Amazon Cognito user pool.resendConfirmationCodeAsync
(ResendConfirmationCodeRequest resendConfirmationCodeRequest) Resends the confirmation (for confirmation of registration) to a specific user in the user pool.resendConfirmationCodeAsync
(ResendConfirmationCodeRequest resendConfirmationCodeRequest, AsyncHandler<ResendConfirmationCodeRequest, ResendConfirmationCodeResult> asyncHandler) Resends the confirmation (for confirmation of registration) to a specific user in the user pool.setUserSettingsAsync
(SetUserSettingsRequest setUserSettingsRequest) Sets the user settings like multi-factor authentication (MFA).setUserSettingsAsync
(SetUserSettingsRequest setUserSettingsRequest, AsyncHandler<SetUserSettingsRequest, SetUserSettingsResult> asyncHandler) Sets the user settings like multi-factor authentication (MFA).signUpAsync
(SignUpRequest signUpRequest) Registers the user in the specified user pool and creates a user name, password, and user attributes.signUpAsync
(SignUpRequest signUpRequest, AsyncHandler<SignUpRequest, SignUpResult> asyncHandler) Registers the user in the specified user pool and creates a user name, password, and user attributes.updateUserAttributesAsync
(UpdateUserAttributesRequest updateUserAttributesRequest) Allows a user to update a specific attribute (one at a time).updateUserAttributesAsync
(UpdateUserAttributesRequest updateUserAttributesRequest, AsyncHandler<UpdateUserAttributesRequest, UpdateUserAttributesResult> asyncHandler) Allows a user to update a specific attribute (one at a time).updateUserPoolAsync
(UpdateUserPoolRequest updateUserPoolRequest) Updates the specified user pool with the specified attributes.updateUserPoolAsync
(UpdateUserPoolRequest updateUserPoolRequest, AsyncHandler<UpdateUserPoolRequest, UpdateUserPoolResult> asyncHandler) Updates the specified user pool with the specified attributes.updateUserPoolClientAsync
(UpdateUserPoolClientRequest updateUserPoolClientRequest) Allows the developer to update the specified user pool client and password policy.updateUserPoolClientAsync
(UpdateUserPoolClientRequest updateUserPoolClientRequest, AsyncHandler<UpdateUserPoolClientRequest, UpdateUserPoolClientResult> asyncHandler) Allows the developer to update the specified user pool client and password policy.verifyUserAttributeAsync
(VerifyUserAttributeRequest verifyUserAttributeRequest) Verifies the specified user attributes in the user pool.verifyUserAttributeAsync
(VerifyUserAttributeRequest verifyUserAttributeRequest, AsyncHandler<VerifyUserAttributeRequest, VerifyUserAttributeResult> asyncHandler) Verifies the specified user attributes in the user pool.Methods inherited from interface com.amazonaws.services.cognitoidp.AWSCognitoIdentityProvider
addCustomAttributes, adminConfirmSignUp, adminDeleteUser, adminDeleteUserAttributes, adminDisableUser, adminEnableUser, adminGetUser, adminResetUserPassword, adminSetUserSettings, adminUpdateUserAttributes, changePassword, confirmForgotPassword, confirmSignUp, createUserPool, createUserPoolClient, deleteUser, deleteUserAttributes, deleteUserPool, deleteUserPoolClient, describeUserPool, describeUserPoolClient, forgotPassword, getCachedResponseMetadata, getUser, getUserAttributeVerificationCode, listUserPoolClients, listUserPools, listUsers, resendConfirmationCode, setEndpoint, setRegion, setUserSettings, shutdown, signUp, updateUserAttributes, updateUserPool, updateUserPoolClient, verifyUserAttribute
-
Method Details
-
addCustomAttributesAsync
Future<AddCustomAttributesResult> addCustomAttributesAsync(AddCustomAttributesRequest addCustomAttributesRequest) Adds additional user attributes to the user pool schema.
- Parameters:
addCustomAttributesRequest
- Represents the request to add custom attributes.- Returns:
- A Java Future containing the result of the AddCustomAttributes operation returned by the service.
-
addCustomAttributesAsync
Future<AddCustomAttributesResult> addCustomAttributesAsync(AddCustomAttributesRequest addCustomAttributesRequest, AsyncHandler<AddCustomAttributesRequest, AddCustomAttributesResult> asyncHandler) Adds additional user attributes to the user pool schema.
- Parameters:
addCustomAttributesRequest
- Represents the request to add custom attributes.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.- Returns:
- A Java Future containing the result of the AddCustomAttributes operation returned by the service.
-
adminConfirmSignUpAsync
Future<AdminConfirmSignUpResult> adminConfirmSignUpAsync(AdminConfirmSignUpRequest adminConfirmSignUpRequest) Confirms user registration as an admin without using a confirmation code. Works on any user.
- Parameters:
adminConfirmSignUpRequest
- Represents the request to confirm user registration.- Returns:
- A Java Future containing the result of the AdminConfirmSignUp operation returned by the service.
-
adminConfirmSignUpAsync
Future<AdminConfirmSignUpResult> adminConfirmSignUpAsync(AdminConfirmSignUpRequest adminConfirmSignUpRequest, AsyncHandler<AdminConfirmSignUpRequest, AdminConfirmSignUpResult> asyncHandler) Confirms user registration as an admin without using a confirmation code. Works on any user.
- Parameters:
adminConfirmSignUpRequest
- Represents the request to confirm user registration.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.- Returns:
- A Java Future containing the result of the AdminConfirmSignUp operation returned by the service.
-
adminDeleteUserAsync
Deletes a user as an administrator. Works on any user.
- Parameters:
adminDeleteUserRequest
- Represents the request to delete a user as an administrator.- Returns:
- A Java Future containing the result of the AdminDeleteUser operation returned by the service.
-
adminDeleteUserAsync
Future<AdminDeleteUserResult> adminDeleteUserAsync(AdminDeleteUserRequest adminDeleteUserRequest, AsyncHandler<AdminDeleteUserRequest, AdminDeleteUserResult> asyncHandler) Deletes a user as an administrator. Works on any user.
- Parameters:
adminDeleteUserRequest
- Represents the request to delete a user as an administrator.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.- Returns:
- A Java Future containing the result of the AdminDeleteUser operation returned by the service.
-
adminDeleteUserAttributesAsync
Future<AdminDeleteUserAttributesResult> adminDeleteUserAttributesAsync(AdminDeleteUserAttributesRequest adminDeleteUserAttributesRequest) Deletes the user attributes in a user pool as an administrator. Works on any user.
- Parameters:
adminDeleteUserAttributesRequest
- Represents the request to delete user attributes as an administrator.- Returns:
- A Java Future containing the result of the AdminDeleteUserAttributes operation returned by the service.
-
adminDeleteUserAttributesAsync
Future<AdminDeleteUserAttributesResult> adminDeleteUserAttributesAsync(AdminDeleteUserAttributesRequest adminDeleteUserAttributesRequest, AsyncHandler<AdminDeleteUserAttributesRequest, AdminDeleteUserAttributesResult> asyncHandler) Deletes the user attributes in a user pool as an administrator. Works on any user.
- Parameters:
adminDeleteUserAttributesRequest
- Represents the request to delete user attributes as an administrator.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.- Returns:
- A Java Future containing the result of the AdminDeleteUserAttributes operation returned by the service.
-
adminDisableUserAsync
Future<AdminDisableUserResult> adminDisableUserAsync(AdminDisableUserRequest adminDisableUserRequest) Disables the specified user as an administrator. Works on any user.
- Parameters:
adminDisableUserRequest
- Represents the request to disable any user as an administrator.- Returns:
- A Java Future containing the result of the AdminDisableUser operation returned by the service.
-
adminDisableUserAsync
Future<AdminDisableUserResult> adminDisableUserAsync(AdminDisableUserRequest adminDisableUserRequest, AsyncHandler<AdminDisableUserRequest, AdminDisableUserResult> asyncHandler) Disables the specified user as an administrator. Works on any user.
- Parameters:
adminDisableUserRequest
- Represents the request to disable any user as an administrator.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.- Returns:
- A Java Future containing the result of the AdminDisableUser operation returned by the service.
-
adminEnableUserAsync
Enables the specified user as an administrator. Works on any user.
- Parameters:
adminEnableUserRequest
- Represents the request that enables the user as an administrator.- Returns:
- A Java Future containing the result of the AdminEnableUser operation returned by the service.
-
adminEnableUserAsync
Future<AdminEnableUserResult> adminEnableUserAsync(AdminEnableUserRequest adminEnableUserRequest, AsyncHandler<AdminEnableUserRequest, AdminEnableUserResult> asyncHandler) Enables the specified user as an administrator. Works on any user.
- Parameters:
adminEnableUserRequest
- Represents the request that enables the user as an administrator.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.- Returns:
- A Java Future containing the result of the AdminEnableUser operation returned by the service.
-
adminGetUserAsync
Gets the specified user by user name in a user pool as an administrator. Works on any user.
- Parameters:
adminGetUserRequest
- Represents the request to get the specified user as an administrator.- Returns:
- A Java Future containing the result of the AdminGetUser operation returned by the service.
-
adminGetUserAsync
Future<AdminGetUserResult> adminGetUserAsync(AdminGetUserRequest adminGetUserRequest, AsyncHandler<AdminGetUserRequest, AdminGetUserResult> asyncHandler) Gets the specified user by user name in a user pool as an administrator. Works on any user.
- Parameters:
adminGetUserRequest
- Represents the request to get the specified user as an administrator.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.- Returns:
- A Java Future containing the result of the AdminGetUser operation returned by the service.
-
adminResetUserPasswordAsync
Future<AdminResetUserPasswordResult> adminResetUserPasswordAsync(AdminResetUserPasswordRequest adminResetUserPasswordRequest) Resets the specified user's password in a user pool as an administrator. Works on any user.
- Parameters:
adminResetUserPasswordRequest
- Represents the request to reset a user's password as an administrator.- Returns:
- A Java Future containing the result of the AdminResetUserPassword operation returned by the service.
-
adminResetUserPasswordAsync
Future<AdminResetUserPasswordResult> adminResetUserPasswordAsync(AdminResetUserPasswordRequest adminResetUserPasswordRequest, AsyncHandler<AdminResetUserPasswordRequest, AdminResetUserPasswordResult> asyncHandler) Resets the specified user's password in a user pool as an administrator. Works on any user.
- Parameters:
adminResetUserPasswordRequest
- Represents the request to reset a user's password as an administrator.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.- Returns:
- A Java Future containing the result of the AdminResetUserPassword operation returned by the service.
-
adminSetUserSettingsAsync
Future<AdminSetUserSettingsResult> adminSetUserSettingsAsync(AdminSetUserSettingsRequest adminSetUserSettingsRequest) Sets all the user settings for a specified user name. Works on any user.
- Parameters:
adminSetUserSettingsRequest
- Represents the request to set user settings as an administrator.- Returns:
- A Java Future containing the result of the AdminSetUserSettings operation returned by the service.
-
adminSetUserSettingsAsync
Future<AdminSetUserSettingsResult> adminSetUserSettingsAsync(AdminSetUserSettingsRequest adminSetUserSettingsRequest, AsyncHandler<AdminSetUserSettingsRequest, AdminSetUserSettingsResult> asyncHandler) Sets all the user settings for a specified user name. Works on any user.
- Parameters:
adminSetUserSettingsRequest
- Represents the request to set user settings as an administrator.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.- Returns:
- A Java Future containing the result of the AdminSetUserSettings operation returned by the service.
-
adminUpdateUserAttributesAsync
Future<AdminUpdateUserAttributesResult> adminUpdateUserAttributesAsync(AdminUpdateUserAttributesRequest adminUpdateUserAttributesRequest) Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.
- Parameters:
adminUpdateUserAttributesRequest
- Represents the request to update the user's attributes as an administrator.- Returns:
- A Java Future containing the result of the AdminUpdateUserAttributes operation returned by the service.
-
adminUpdateUserAttributesAsync
Future<AdminUpdateUserAttributesResult> adminUpdateUserAttributesAsync(AdminUpdateUserAttributesRequest adminUpdateUserAttributesRequest, AsyncHandler<AdminUpdateUserAttributesRequest, AdminUpdateUserAttributesResult> asyncHandler) Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.
- Parameters:
adminUpdateUserAttributesRequest
- Represents the request to update the user's attributes as an administrator.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.- Returns:
- A Java Future containing the result of the AdminUpdateUserAttributes operation returned by the service.
-
changePasswordAsync
Changes the password for a specified user in a user pool.
- Parameters:
changePasswordRequest
- Represents the request to change a user password.- Returns:
- A Java Future containing the result of the ChangePassword operation returned by the service.
-
changePasswordAsync
Future<ChangePasswordResult> changePasswordAsync(ChangePasswordRequest changePasswordRequest, AsyncHandler<ChangePasswordRequest, ChangePasswordResult> asyncHandler) Changes the password for a specified user in a user pool.
- Parameters:
changePasswordRequest
- Represents the request to change a user password.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.- Returns:
- A Java Future containing the result of the ChangePassword operation returned by the service.
-
confirmForgotPasswordAsync
Future<ConfirmForgotPasswordResult> confirmForgotPasswordAsync(ConfirmForgotPasswordRequest confirmForgotPasswordRequest) Allows a user to enter a code provided when they reset their password to update their password.
- Parameters:
confirmForgotPasswordRequest
- The request representing the confirmation for a password reset.- Returns:
- A Java Future containing the result of the ConfirmForgotPassword operation returned by the service.
-
confirmForgotPasswordAsync
Future<ConfirmForgotPasswordResult> confirmForgotPasswordAsync(ConfirmForgotPasswordRequest confirmForgotPasswordRequest, AsyncHandler<ConfirmForgotPasswordRequest, ConfirmForgotPasswordResult> asyncHandler) Allows a user to enter a code provided when they reset their password to update their password.
- Parameters:
confirmForgotPasswordRequest
- The request representing the confirmation for a password reset.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.- Returns:
- A Java Future containing the result of the ConfirmForgotPassword operation returned by the service.
-
confirmSignUpAsync
Confirms registration of a user and handles the existing alias from a previous user.
- Parameters:
confirmSignUpRequest
- Represents the request to confirm registration of a user.- Returns:
- A Java Future containing the result of the ConfirmSignUp operation returned by the service.
-
confirmSignUpAsync
Future<ConfirmSignUpResult> confirmSignUpAsync(ConfirmSignUpRequest confirmSignUpRequest, AsyncHandler<ConfirmSignUpRequest, ConfirmSignUpResult> asyncHandler) Confirms registration of a user and handles the existing alias from a previous user.
- Parameters:
confirmSignUpRequest
- Represents the request to confirm registration of a user.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.- Returns:
- A Java Future containing the result of the ConfirmSignUp operation returned by the service.
-
createUserPoolAsync
Creates a new Amazon Cognito user pool and sets the password policy for the pool.
- Parameters:
createUserPoolRequest
- Represents the request to create a user pool.- Returns:
- A Java Future containing the result of the CreateUserPool operation returned by the service.
-
createUserPoolAsync
Future<CreateUserPoolResult> createUserPoolAsync(CreateUserPoolRequest createUserPoolRequest, AsyncHandler<CreateUserPoolRequest, CreateUserPoolResult> asyncHandler) Creates a new Amazon Cognito user pool and sets the password policy for the pool.
- Parameters:
createUserPoolRequest
- Represents the request to create a user pool.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.- Returns:
- A Java Future containing the result of the CreateUserPool operation returned by the service.
-
createUserPoolClientAsync
Future<CreateUserPoolClientResult> createUserPoolClientAsync(CreateUserPoolClientRequest createUserPoolClientRequest) Creates the user pool client.
- Parameters:
createUserPoolClientRequest
- Represents the request to create a user pool client.- Returns:
- A Java Future containing the result of the CreateUserPoolClient operation returned by the service.
-
createUserPoolClientAsync
Future<CreateUserPoolClientResult> createUserPoolClientAsync(CreateUserPoolClientRequest createUserPoolClientRequest, AsyncHandler<CreateUserPoolClientRequest, CreateUserPoolClientResult> asyncHandler) Creates the user pool client.
- Parameters:
createUserPoolClientRequest
- Represents the request to create a user pool client.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.- Returns:
- A Java Future containing the result of the CreateUserPoolClient operation returned by the service.
-
deleteUserAsync
Allows a user to delete one's self.
- Parameters:
deleteUserRequest
- Represents the request to delete a user.- Returns:
- A Java Future containing the result of the DeleteUser operation returned by the service.
-
deleteUserAsync
Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest deleteUserRequest, AsyncHandler<DeleteUserRequest, DeleteUserResult> asyncHandler) Allows a user to delete one's self.
- Parameters:
deleteUserRequest
- Represents the request to delete a user.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.- Returns:
- A Java Future containing the result of the DeleteUser operation returned by the service.
-
deleteUserAttributesAsync
Future<DeleteUserAttributesResult> deleteUserAttributesAsync(DeleteUserAttributesRequest deleteUserAttributesRequest) Deletes the attributes for a user.
- Parameters:
deleteUserAttributesRequest
- Represents the request to delete user attributes.- Returns:
- A Java Future containing the result of the DeleteUserAttributes operation returned by the service.
-
deleteUserAttributesAsync
Future<DeleteUserAttributesResult> deleteUserAttributesAsync(DeleteUserAttributesRequest deleteUserAttributesRequest, AsyncHandler<DeleteUserAttributesRequest, DeleteUserAttributesResult> asyncHandler) Deletes the attributes for a user.
- Parameters:
deleteUserAttributesRequest
- Represents the request to delete user attributes.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.- Returns:
- A Java Future containing the result of the DeleteUserAttributes operation returned by the service.
-
deleteUserPoolAsync
Deletes the specified Amazon Cognito user pool.
- Parameters:
deleteUserPoolRequest
- Represents the request to delete a user pool.- Returns:
- A Java Future containing the result of the DeleteUserPool operation returned by the service.
-
deleteUserPoolAsync
Future<DeleteUserPoolResult> deleteUserPoolAsync(DeleteUserPoolRequest deleteUserPoolRequest, AsyncHandler<DeleteUserPoolRequest, DeleteUserPoolResult> asyncHandler) Deletes the specified Amazon Cognito user pool.
- Parameters:
deleteUserPoolRequest
- Represents the request to delete a user pool.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.- Returns:
- A Java Future containing the result of the DeleteUserPool operation returned by the service.
-
deleteUserPoolClientAsync
Future<DeleteUserPoolClientResult> deleteUserPoolClientAsync(DeleteUserPoolClientRequest deleteUserPoolClientRequest) Allows the developer to delete the user pool client.
- Parameters:
deleteUserPoolClientRequest
- Represents the request to delete a user pool client.- Returns:
- A Java Future containing the result of the DeleteUserPoolClient operation returned by the service.
-
deleteUserPoolClientAsync
Future<DeleteUserPoolClientResult> deleteUserPoolClientAsync(DeleteUserPoolClientRequest deleteUserPoolClientRequest, AsyncHandler<DeleteUserPoolClientRequest, DeleteUserPoolClientResult> asyncHandler) Allows the developer to delete the user pool client.
- Parameters:
deleteUserPoolClientRequest
- Represents the request to delete a user pool client.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.- Returns:
- A Java Future containing the result of the DeleteUserPoolClient operation returned by the service.
-
describeUserPoolAsync
Future<DescribeUserPoolResult> describeUserPoolAsync(DescribeUserPoolRequest describeUserPoolRequest) Returns the configuration information and metadata of the specified user pool.
- Parameters:
describeUserPoolRequest
- Represents the request to describe the user pool.- Returns:
- A Java Future containing the result of the DescribeUserPool operation returned by the service.
-
describeUserPoolAsync
Future<DescribeUserPoolResult> describeUserPoolAsync(DescribeUserPoolRequest describeUserPoolRequest, AsyncHandler<DescribeUserPoolRequest, DescribeUserPoolResult> asyncHandler) Returns the configuration information and metadata of the specified user pool.
- Parameters:
describeUserPoolRequest
- Represents the request to describe the user pool.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.- Returns:
- A Java Future containing the result of the DescribeUserPool operation returned by the service.
-
describeUserPoolClientAsync
Future<DescribeUserPoolClientResult> describeUserPoolClientAsync(DescribeUserPoolClientRequest describeUserPoolClientRequest) Client method for returning the configuration information and metadata of the specified user pool client.
- Parameters:
describeUserPoolClientRequest
- Represents the request to describe a user pool client.- Returns:
- A Java Future containing the result of the DescribeUserPoolClient operation returned by the service.
-
describeUserPoolClientAsync
Future<DescribeUserPoolClientResult> describeUserPoolClientAsync(DescribeUserPoolClientRequest describeUserPoolClientRequest, AsyncHandler<DescribeUserPoolClientRequest, DescribeUserPoolClientResult> asyncHandler) Client method for returning the configuration information and metadata of the specified user pool client.
- Parameters:
describeUserPoolClientRequest
- Represents the request to describe a user pool client.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.- Returns:
- A Java Future containing the result of the DescribeUserPoolClient operation returned by the service.
-
forgotPasswordAsync
Retrieves the password for the specified client ID or username.
- Parameters:
forgotPasswordRequest
- Represents the request to reset a user's password.- Returns:
- A Java Future containing the result of the ForgotPassword operation returned by the service.
-
forgotPasswordAsync
Future<ForgotPasswordResult> forgotPasswordAsync(ForgotPasswordRequest forgotPasswordRequest, AsyncHandler<ForgotPasswordRequest, ForgotPasswordResult> asyncHandler) Retrieves the password for the specified client ID or username.
- Parameters:
forgotPasswordRequest
- Represents the request to reset a user's password.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.- Returns:
- A Java Future containing the result of the ForgotPassword operation returned by the service.
-
getUserAsync
Gets the user attributes and metadata for a user.
- Parameters:
getUserRequest
- Represents the request to get information about the user.- Returns:
- A Java Future containing the result of the GetUser operation returned by the service.
-
getUserAsync
Future<GetUserResult> getUserAsync(GetUserRequest getUserRequest, AsyncHandler<GetUserRequest, GetUserResult> asyncHandler) Gets the user attributes and metadata for a user.
- Parameters:
getUserRequest
- Represents the request to get information about the user.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.- Returns:
- A Java Future containing the result of the GetUser operation returned by the service.
-
getUserAttributeVerificationCodeAsync
Future<GetUserAttributeVerificationCodeResult> getUserAttributeVerificationCodeAsync(GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest) Gets the user attribute verification code for the specified attribute name.
- Parameters:
getUserAttributeVerificationCodeRequest
- Represents the request to get user attribute verification.- Returns:
- A Java Future containing the result of the GetUserAttributeVerificationCode operation returned by the service.
-
getUserAttributeVerificationCodeAsync
Future<GetUserAttributeVerificationCodeResult> getUserAttributeVerificationCodeAsync(GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest, AsyncHandler<GetUserAttributeVerificationCodeRequest, GetUserAttributeVerificationCodeResult> asyncHandler) Gets the user attribute verification code for the specified attribute name.
- Parameters:
getUserAttributeVerificationCodeRequest
- Represents the request to get user attribute verification.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.- Returns:
- A Java Future containing the result of the GetUserAttributeVerificationCode operation returned by the service.
-
listUserPoolClientsAsync
Future<ListUserPoolClientsResult> listUserPoolClientsAsync(ListUserPoolClientsRequest listUserPoolClientsRequest) Lists the clients that have been created for the specified user pool.
- Parameters:
listUserPoolClientsRequest
- Represents the request to list the user pool clients.- Returns:
- A Java Future containing the result of the ListUserPoolClients operation returned by the service.
-
listUserPoolClientsAsync
Future<ListUserPoolClientsResult> listUserPoolClientsAsync(ListUserPoolClientsRequest listUserPoolClientsRequest, AsyncHandler<ListUserPoolClientsRequest, ListUserPoolClientsResult> asyncHandler) Lists the clients that have been created for the specified user pool.
- Parameters:
listUserPoolClientsRequest
- Represents the request to list the user pool clients.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.- Returns:
- A Java Future containing the result of the ListUserPoolClients operation returned by the service.
-
listUserPoolsAsync
Lists the user pools associated with an AWS account.
- Parameters:
listUserPoolsRequest
- Represents the request to list user pools.- Returns:
- A Java Future containing the result of the ListUserPools operation returned by the service.
-
listUserPoolsAsync
Future<ListUserPoolsResult> listUserPoolsAsync(ListUserPoolsRequest listUserPoolsRequest, AsyncHandler<ListUserPoolsRequest, ListUserPoolsResult> asyncHandler) Lists the user pools associated with an AWS account.
- Parameters:
listUserPoolsRequest
- Represents the request to list user pools.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.- Returns:
- A Java Future containing the result of the ListUserPools operation returned by the service.
-
listUsersAsync
Lists the users in the Amazon Cognito user pool.
- Parameters:
listUsersRequest
- Represents the request to list users.- Returns:
- A Java Future containing the result of the ListUsers operation returned by the service.
-
listUsersAsync
Future<ListUsersResult> listUsersAsync(ListUsersRequest listUsersRequest, AsyncHandler<ListUsersRequest, ListUsersResult> asyncHandler) Lists the users in the Amazon Cognito user pool.
- Parameters:
listUsersRequest
- Represents the request to list users.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.- Returns:
- A Java Future containing the result of the ListUsers operation returned by the service.
-
resendConfirmationCodeAsync
Future<ResendConfirmationCodeResult> resendConfirmationCodeAsync(ResendConfirmationCodeRequest resendConfirmationCodeRequest) Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
- Parameters:
resendConfirmationCodeRequest
- Represents the request to resend the confirmation code.- Returns:
- A Java Future containing the result of the ResendConfirmationCode operation returned by the service.
-
resendConfirmationCodeAsync
Future<ResendConfirmationCodeResult> resendConfirmationCodeAsync(ResendConfirmationCodeRequest resendConfirmationCodeRequest, AsyncHandler<ResendConfirmationCodeRequest, ResendConfirmationCodeResult> asyncHandler) Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
- Parameters:
resendConfirmationCodeRequest
- Represents the request to resend the confirmation code.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.- Returns:
- A Java Future containing the result of the ResendConfirmationCode operation returned by the service.
-
setUserSettingsAsync
Sets the user settings like multi-factor authentication (MFA). If MFA is to be removed for a particular attribute pass the attribute with code delivery as null. If null list is passed, all MFA options are removed.
- Parameters:
setUserSettingsRequest
- Represents the request to set user settings.- Returns:
- A Java Future containing the result of the SetUserSettings operation returned by the service.
-
setUserSettingsAsync
Future<SetUserSettingsResult> setUserSettingsAsync(SetUserSettingsRequest setUserSettingsRequest, AsyncHandler<SetUserSettingsRequest, SetUserSettingsResult> asyncHandler) Sets the user settings like multi-factor authentication (MFA). If MFA is to be removed for a particular attribute pass the attribute with code delivery as null. If null list is passed, all MFA options are removed.
- Parameters:
setUserSettingsRequest
- Represents the request to set user settings.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.- Returns:
- A Java Future containing the result of the SetUserSettings operation returned by the service.
-
signUpAsync
Registers the user in the specified user pool and creates a user name, password, and user attributes.
- Parameters:
signUpRequest
- Represents the request to register a user.- Returns:
- A Java Future containing the result of the SignUp operation returned by the service.
-
signUpAsync
Future<SignUpResult> signUpAsync(SignUpRequest signUpRequest, AsyncHandler<SignUpRequest, SignUpResult> asyncHandler) Registers the user in the specified user pool and creates a user name, password, and user attributes.
- Parameters:
signUpRequest
- Represents the request to register a user.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.- Returns:
- A Java Future containing the result of the SignUp operation returned by the service.
-
updateUserAttributesAsync
Future<UpdateUserAttributesResult> updateUserAttributesAsync(UpdateUserAttributesRequest updateUserAttributesRequest) Allows a user to update a specific attribute (one at a time).
- Parameters:
updateUserAttributesRequest
- Represents the request to update user attributes.- Returns:
- A Java Future containing the result of the UpdateUserAttributes operation returned by the service.
-
updateUserAttributesAsync
Future<UpdateUserAttributesResult> updateUserAttributesAsync(UpdateUserAttributesRequest updateUserAttributesRequest, AsyncHandler<UpdateUserAttributesRequest, UpdateUserAttributesResult> asyncHandler) Allows a user to update a specific attribute (one at a time).
- Parameters:
updateUserAttributesRequest
- Represents the request to update user attributes.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.- Returns:
- A Java Future containing the result of the UpdateUserAttributes operation returned by the service.
-
updateUserPoolAsync
Updates the specified user pool with the specified attributes.
- Parameters:
updateUserPoolRequest
- Represents the request to update the user pool.- Returns:
- A Java Future containing the result of the UpdateUserPool operation returned by the service.
-
updateUserPoolAsync
Future<UpdateUserPoolResult> updateUserPoolAsync(UpdateUserPoolRequest updateUserPoolRequest, AsyncHandler<UpdateUserPoolRequest, UpdateUserPoolResult> asyncHandler) Updates the specified user pool with the specified attributes.
- Parameters:
updateUserPoolRequest
- Represents the request to update the user pool.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.- Returns:
- A Java Future containing the result of the UpdateUserPool operation returned by the service.
-
updateUserPoolClientAsync
Future<UpdateUserPoolClientResult> updateUserPoolClientAsync(UpdateUserPoolClientRequest updateUserPoolClientRequest) Allows the developer to update the specified user pool client and password policy.
- Parameters:
updateUserPoolClientRequest
- Represents the request to update the user pool client.- Returns:
- A Java Future containing the result of the UpdateUserPoolClient operation returned by the service.
-
updateUserPoolClientAsync
Future<UpdateUserPoolClientResult> updateUserPoolClientAsync(UpdateUserPoolClientRequest updateUserPoolClientRequest, AsyncHandler<UpdateUserPoolClientRequest, UpdateUserPoolClientResult> asyncHandler) Allows the developer to update the specified user pool client and password policy.
- Parameters:
updateUserPoolClientRequest
- Represents the request to update the user pool client.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.- Returns:
- A Java Future containing the result of the UpdateUserPoolClient operation returned by the service.
-
verifyUserAttributeAsync
Future<VerifyUserAttributeResult> verifyUserAttributeAsync(VerifyUserAttributeRequest verifyUserAttributeRequest) Verifies the specified user attributes in the user pool.
- Parameters:
verifyUserAttributeRequest
- Represents the request to verify user attributes.- Returns:
- A Java Future containing the result of the VerifyUserAttribute operation returned by the service.
-
verifyUserAttributeAsync
Future<VerifyUserAttributeResult> verifyUserAttributeAsync(VerifyUserAttributeRequest verifyUserAttributeRequest, AsyncHandler<VerifyUserAttributeRequest, VerifyUserAttributeResult> asyncHandler) Verifies the specified user attributes in the user pool.
- Parameters:
verifyUserAttributeRequest
- Represents the request to verify user attributes.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.- Returns:
- A Java Future containing the result of the VerifyUserAttribute operation returned by the service.
-