public interface AWSCognitoIdentityProviderAsync extends AWSCognitoIdentityProvider
AsyncHandler can be used to
receive notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSCognitoIdentityProviderAsync instead.
Using the Amazon Cognito Your 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 Your User Pools.
For more information, see the Amazon Cognito Documentation.
ENDPOINT_PREFIXaddCustomAttributes, adminConfirmSignUp, adminCreateUser, adminDeleteUser, adminDeleteUserAttributes, adminDisableUser, adminEnableUser, adminForgetDevice, adminGetDevice, adminGetUser, adminInitiateAuth, adminListDevices, adminResetUserPassword, adminRespondToAuthChallenge, adminSetUserSettings, adminUpdateDeviceStatus, adminUpdateUserAttributes, adminUserGlobalSignOut, changePassword, confirmDevice, confirmForgotPassword, confirmSignUp, createUserImportJob, createUserPool, createUserPoolClient, deleteUser, deleteUserAttributes, deleteUserPool, deleteUserPoolClient, describeUserImportJob, describeUserPool, describeUserPoolClient, forgetDevice, forgotPassword, getCachedResponseMetadata, getCSVHeader, getDevice, getUser, getUserAttributeVerificationCode, globalSignOut, initiateAuth, listDevices, listUserImportJobs, listUserPoolClients, listUserPools, listUsers, resendConfirmationCode, respondToAuthChallenge, setEndpoint, setRegion, setUserSettings, shutdown, signUp, startUserImportJob, stopUserImportJob, updateDeviceStatus, updateUserAttributes, updateUserPool, updateUserPoolClient, verifyUserAttributeFuture<AddCustomAttributesResult> addCustomAttributesAsync(AddCustomAttributesRequest addCustomAttributesRequest)
Adds additional user attributes to the user pool schema.
addCustomAttributesRequest - Represents the request to add custom attributes.Future<AddCustomAttributesResult> addCustomAttributesAsync(AddCustomAttributesRequest addCustomAttributesRequest, AsyncHandler<AddCustomAttributesRequest,AddCustomAttributesResult> asyncHandler)
Adds additional user attributes to the user pool schema.
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.Future<AdminConfirmSignUpResult> adminConfirmSignUpAsync(AdminConfirmSignUpRequest adminConfirmSignUpRequest)
Confirms user registration as an admin without using a confirmation code. Works on any user.
adminConfirmSignUpRequest - Represents the request to confirm user registration.Future<AdminConfirmSignUpResult> adminConfirmSignUpAsync(AdminConfirmSignUpRequest adminConfirmSignUpRequest, AsyncHandler<AdminConfirmSignUpRequest,AdminConfirmSignUpResult> asyncHandler)
Confirms user registration as an admin without using a confirmation code. Works on any user.
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.Future<AdminCreateUserResult> adminCreateUserAsync(AdminCreateUserRequest adminCreateUserRequest)
Creates a new user in the specified user pool and sends a welcome message via email or phone (SMS). This message is based on a template that you configured in your call to CreateUserPool or UpdateUserPool. This template includes your custom sign-up instructions and placeholders for user name and temporary password.
Requires developer credentials.
adminCreateUserRequest - Represents the request to create a user in the specified user pool.Future<AdminCreateUserResult> adminCreateUserAsync(AdminCreateUserRequest adminCreateUserRequest, AsyncHandler<AdminCreateUserRequest,AdminCreateUserResult> asyncHandler)
Creates a new user in the specified user pool and sends a welcome message via email or phone (SMS). This message is based on a template that you configured in your call to CreateUserPool or UpdateUserPool. This template includes your custom sign-up instructions and placeholders for user name and temporary password.
Requires developer credentials.
adminCreateUserRequest - Represents the request to create a user in the specified 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.Future<AdminDeleteUserResult> adminDeleteUserAsync(AdminDeleteUserRequest adminDeleteUserRequest)
Deletes a user as an administrator. Works on any user.
adminDeleteUserRequest - Represents the request to delete a user as an administrator.Future<AdminDeleteUserResult> adminDeleteUserAsync(AdminDeleteUserRequest adminDeleteUserRequest, AsyncHandler<AdminDeleteUserRequest,AdminDeleteUserResult> asyncHandler)
Deletes a user as an administrator. Works on any user.
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.Future<AdminDeleteUserAttributesResult> adminDeleteUserAttributesAsync(AdminDeleteUserAttributesRequest adminDeleteUserAttributesRequest)
Deletes the user attributes in a user pool as an administrator. Works on any user.
adminDeleteUserAttributesRequest - Represents the request to delete user attributes as an administrator.Future<AdminDeleteUserAttributesResult> adminDeleteUserAttributesAsync(AdminDeleteUserAttributesRequest adminDeleteUserAttributesRequest, AsyncHandler<AdminDeleteUserAttributesRequest,AdminDeleteUserAttributesResult> asyncHandler)
Deletes the user attributes in a user pool as an administrator. Works on any user.
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.Future<AdminDisableUserResult> adminDisableUserAsync(AdminDisableUserRequest adminDisableUserRequest)
Disables the specified user as an administrator. Works on any user.
adminDisableUserRequest - Represents the request to disable any user as an administrator.Future<AdminDisableUserResult> adminDisableUserAsync(AdminDisableUserRequest adminDisableUserRequest, AsyncHandler<AdminDisableUserRequest,AdminDisableUserResult> asyncHandler)
Disables the specified user as an administrator. Works on any user.
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.Future<AdminEnableUserResult> adminEnableUserAsync(AdminEnableUserRequest adminEnableUserRequest)
Enables the specified user as an administrator. Works on any user.
adminEnableUserRequest - Represents the request that enables the user as an administrator.Future<AdminEnableUserResult> adminEnableUserAsync(AdminEnableUserRequest adminEnableUserRequest, AsyncHandler<AdminEnableUserRequest,AdminEnableUserResult> asyncHandler)
Enables the specified user as an administrator. Works on any user.
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.Future<AdminForgetDeviceResult> adminForgetDeviceAsync(AdminForgetDeviceRequest adminForgetDeviceRequest)
Forgets the device, as an administrator.
adminForgetDeviceRequest - Sends the forgot device request, as an administrator.Future<AdminForgetDeviceResult> adminForgetDeviceAsync(AdminForgetDeviceRequest adminForgetDeviceRequest, AsyncHandler<AdminForgetDeviceRequest,AdminForgetDeviceResult> asyncHandler)
Forgets the device, as an administrator.
adminForgetDeviceRequest - Sends the forgot device request, 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.Future<AdminGetDeviceResult> adminGetDeviceAsync(AdminGetDeviceRequest adminGetDeviceRequest)
Gets the device, as an administrator.
adminGetDeviceRequest - Represents the request to get the device, as an administrator.Future<AdminGetDeviceResult> adminGetDeviceAsync(AdminGetDeviceRequest adminGetDeviceRequest, AsyncHandler<AdminGetDeviceRequest,AdminGetDeviceResult> asyncHandler)
Gets the device, as an administrator.
adminGetDeviceRequest - Represents the request to get the device, 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.Future<AdminGetUserResult> adminGetUserAsync(AdminGetUserRequest adminGetUserRequest)
Gets the specified user by user name in a user pool as an administrator. Works on any user.
adminGetUserRequest - Represents the request to get the specified user as an administrator.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.
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.Future<AdminInitiateAuthResult> adminInitiateAuthAsync(AdminInitiateAuthRequest adminInitiateAuthRequest)
Initiates the authentication flow, as an administrator.
adminInitiateAuthRequest - Initiates the authorization request, as an administrator.Future<AdminInitiateAuthResult> adminInitiateAuthAsync(AdminInitiateAuthRequest adminInitiateAuthRequest, AsyncHandler<AdminInitiateAuthRequest,AdminInitiateAuthResult> asyncHandler)
Initiates the authentication flow, as an administrator.
adminInitiateAuthRequest - Initiates the authorization request, 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.Future<AdminListDevicesResult> adminListDevicesAsync(AdminListDevicesRequest adminListDevicesRequest)
Lists devices, as an administrator.
adminListDevicesRequest - Represents the request to list devices, as an administrator.Future<AdminListDevicesResult> adminListDevicesAsync(AdminListDevicesRequest adminListDevicesRequest, AsyncHandler<AdminListDevicesRequest,AdminListDevicesResult> asyncHandler)
Lists devices, as an administrator.
adminListDevicesRequest - Represents the request to list devices, 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.Future<AdminResetUserPasswordResult> adminResetUserPasswordAsync(AdminResetUserPasswordRequest adminResetUserPasswordRequest)
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.
adminResetUserPasswordRequest - Represents the request to reset a user's password as an administrator.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.
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.
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.Future<AdminRespondToAuthChallengeResult> adminRespondToAuthChallengeAsync(AdminRespondToAuthChallengeRequest adminRespondToAuthChallengeRequest)
Responds to an authentication challenge, as an administrator.
adminRespondToAuthChallengeRequest - The request to respond to the authentication challenge, as an administrator.Future<AdminRespondToAuthChallengeResult> adminRespondToAuthChallengeAsync(AdminRespondToAuthChallengeRequest adminRespondToAuthChallengeRequest, AsyncHandler<AdminRespondToAuthChallengeRequest,AdminRespondToAuthChallengeResult> asyncHandler)
Responds to an authentication challenge, as an administrator.
adminRespondToAuthChallengeRequest - The request to respond to the authentication challenge, 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.Future<AdminSetUserSettingsResult> adminSetUserSettingsAsync(AdminSetUserSettingsRequest adminSetUserSettingsRequest)
Sets all the user settings for a specified user name. Works on any user.
adminSetUserSettingsRequest - Represents the request to set user settings as an administrator.Future<AdminSetUserSettingsResult> adminSetUserSettingsAsync(AdminSetUserSettingsRequest adminSetUserSettingsRequest, AsyncHandler<AdminSetUserSettingsRequest,AdminSetUserSettingsResult> asyncHandler)
Sets all the user settings for a specified user name. Works on any user.
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.Future<AdminUpdateDeviceStatusResult> adminUpdateDeviceStatusAsync(AdminUpdateDeviceStatusRequest adminUpdateDeviceStatusRequest)
Updates the device status as an administrator.
adminUpdateDeviceStatusRequest - The request to update the device status, as an administrator.Future<AdminUpdateDeviceStatusResult> adminUpdateDeviceStatusAsync(AdminUpdateDeviceStatusRequest adminUpdateDeviceStatusRequest, AsyncHandler<AdminUpdateDeviceStatusRequest,AdminUpdateDeviceStatusResult> asyncHandler)
Updates the device status as an administrator.
adminUpdateDeviceStatusRequest - The request to update the device status, 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.Future<AdminUpdateUserAttributesResult> adminUpdateUserAttributesAsync(AdminUpdateUserAttributesRequest adminUpdateUserAttributesRequest)
Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.
adminUpdateUserAttributesRequest - Represents the request to update the user's attributes as an administrator.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.
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.Future<AdminUserGlobalSignOutResult> adminUserGlobalSignOutAsync(AdminUserGlobalSignOutRequest adminUserGlobalSignOutRequest)
Signs out users from all devices, as an administrator.
adminUserGlobalSignOutRequest - The request to sign out of all devices, as an administrator.Future<AdminUserGlobalSignOutResult> adminUserGlobalSignOutAsync(AdminUserGlobalSignOutRequest adminUserGlobalSignOutRequest, AsyncHandler<AdminUserGlobalSignOutRequest,AdminUserGlobalSignOutResult> asyncHandler)
Signs out users from all devices, as an administrator.
adminUserGlobalSignOutRequest - The request to sign out of all devices, 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.Future<ChangePasswordResult> changePasswordAsync(ChangePasswordRequest changePasswordRequest)
Changes the password for a specified user in a user pool.
changePasswordRequest - Represents the request to change a user password.Future<ChangePasswordResult> changePasswordAsync(ChangePasswordRequest changePasswordRequest, AsyncHandler<ChangePasswordRequest,ChangePasswordResult> asyncHandler)
Changes the password for a specified user in a user pool.
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.Future<ConfirmDeviceResult> confirmDeviceAsync(ConfirmDeviceRequest confirmDeviceRequest)
Confirms tracking of the device. This API call is the call that beings device tracking.
confirmDeviceRequest - Confirms the device request.Future<ConfirmDeviceResult> confirmDeviceAsync(ConfirmDeviceRequest confirmDeviceRequest, AsyncHandler<ConfirmDeviceRequest,ConfirmDeviceResult> asyncHandler)
Confirms tracking of the device. This API call is the call that beings device tracking.
confirmDeviceRequest - Confirms the device request.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.Future<ConfirmForgotPasswordResult> confirmForgotPasswordAsync(ConfirmForgotPasswordRequest confirmForgotPasswordRequest)
Allows a user to enter a code provided when they reset their password to update their password.
confirmForgotPasswordRequest - The request representing the confirmation for a password reset.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.
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.Future<ConfirmSignUpResult> confirmSignUpAsync(ConfirmSignUpRequest confirmSignUpRequest)
Confirms registration of a user and handles the existing alias from a previous user.
confirmSignUpRequest - Represents the request to confirm registration of a user.Future<ConfirmSignUpResult> confirmSignUpAsync(ConfirmSignUpRequest confirmSignUpRequest, AsyncHandler<ConfirmSignUpRequest,ConfirmSignUpResult> asyncHandler)
Confirms registration of a user and handles the existing alias from a previous user.
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.Future<CreateUserImportJobResult> createUserImportJobAsync(CreateUserImportJobRequest createUserImportJobRequest)
Creates the user import job.
createUserImportJobRequest - Represents the request to create the user import job.Future<CreateUserImportJobResult> createUserImportJobAsync(CreateUserImportJobRequest createUserImportJobRequest, AsyncHandler<CreateUserImportJobRequest,CreateUserImportJobResult> asyncHandler)
Creates the user import job.
createUserImportJobRequest - Represents the request to create the user import job.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.Future<CreateUserPoolResult> createUserPoolAsync(CreateUserPoolRequest createUserPoolRequest)
Creates a new Amazon Cognito user pool and sets the password policy for the pool.
createUserPoolRequest - Represents the request to create a user pool.Future<CreateUserPoolResult> createUserPoolAsync(CreateUserPoolRequest createUserPoolRequest, AsyncHandler<CreateUserPoolRequest,CreateUserPoolResult> asyncHandler)
Creates a new Amazon Cognito user pool and sets the password policy for the pool.
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.Future<CreateUserPoolClientResult> createUserPoolClientAsync(CreateUserPoolClientRequest createUserPoolClientRequest)
Creates the user pool client.
createUserPoolClientRequest - Represents the request to create a user pool client.Future<CreateUserPoolClientResult> createUserPoolClientAsync(CreateUserPoolClientRequest createUserPoolClientRequest, AsyncHandler<CreateUserPoolClientRequest,CreateUserPoolClientResult> asyncHandler)
Creates the user pool client.
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.Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest deleteUserRequest)
Allows a user to delete one's self.
deleteUserRequest - Represents the request to delete a user.Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest deleteUserRequest, AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)
Allows a user to delete one's self.
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.Future<DeleteUserAttributesResult> deleteUserAttributesAsync(DeleteUserAttributesRequest deleteUserAttributesRequest)
Deletes the attributes for a user.
deleteUserAttributesRequest - Represents the request to delete user attributes.Future<DeleteUserAttributesResult> deleteUserAttributesAsync(DeleteUserAttributesRequest deleteUserAttributesRequest, AsyncHandler<DeleteUserAttributesRequest,DeleteUserAttributesResult> asyncHandler)
Deletes the attributes for a user.
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.Future<DeleteUserPoolResult> deleteUserPoolAsync(DeleteUserPoolRequest deleteUserPoolRequest)
Deletes the specified Amazon Cognito user pool.
deleteUserPoolRequest - Represents the request to delete a user pool.Future<DeleteUserPoolResult> deleteUserPoolAsync(DeleteUserPoolRequest deleteUserPoolRequest, AsyncHandler<DeleteUserPoolRequest,DeleteUserPoolResult> asyncHandler)
Deletes the specified Amazon Cognito user pool.
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.Future<DeleteUserPoolClientResult> deleteUserPoolClientAsync(DeleteUserPoolClientRequest deleteUserPoolClientRequest)
Allows the developer to delete the user pool client.
deleteUserPoolClientRequest - Represents the request to delete a user pool client.Future<DeleteUserPoolClientResult> deleteUserPoolClientAsync(DeleteUserPoolClientRequest deleteUserPoolClientRequest, AsyncHandler<DeleteUserPoolClientRequest,DeleteUserPoolClientResult> asyncHandler)
Allows the developer to delete the user pool client.
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.Future<DescribeUserImportJobResult> describeUserImportJobAsync(DescribeUserImportJobRequest describeUserImportJobRequest)
Describes the user import job.
describeUserImportJobRequest - Represents the request to describe the user import job.Future<DescribeUserImportJobResult> describeUserImportJobAsync(DescribeUserImportJobRequest describeUserImportJobRequest, AsyncHandler<DescribeUserImportJobRequest,DescribeUserImportJobResult> asyncHandler)
Describes the user import job.
describeUserImportJobRequest - Represents the request to describe the user import job.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.Future<DescribeUserPoolResult> describeUserPoolAsync(DescribeUserPoolRequest describeUserPoolRequest)
Returns the configuration information and metadata of the specified user pool.
describeUserPoolRequest - Represents the request to describe the user pool.Future<DescribeUserPoolResult> describeUserPoolAsync(DescribeUserPoolRequest describeUserPoolRequest, AsyncHandler<DescribeUserPoolRequest,DescribeUserPoolResult> asyncHandler)
Returns the configuration information and metadata of the specified user pool.
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.Future<DescribeUserPoolClientResult> describeUserPoolClientAsync(DescribeUserPoolClientRequest describeUserPoolClientRequest)
Client method for returning the configuration information and metadata of the specified user pool client.
describeUserPoolClientRequest - Represents the request to describe a user pool client.Future<DescribeUserPoolClientResult> describeUserPoolClientAsync(DescribeUserPoolClientRequest describeUserPoolClientRequest, AsyncHandler<DescribeUserPoolClientRequest,DescribeUserPoolClientResult> asyncHandler)
Client method for returning the configuration information and metadata of the specified user pool client.
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.Future<ForgetDeviceResult> forgetDeviceAsync(ForgetDeviceRequest forgetDeviceRequest)
Forgets the specified device.
forgetDeviceRequest - Represents the request to forget the device.Future<ForgetDeviceResult> forgetDeviceAsync(ForgetDeviceRequest forgetDeviceRequest, AsyncHandler<ForgetDeviceRequest,ForgetDeviceResult> asyncHandler)
Forgets the specified device.
forgetDeviceRequest - Represents the request to forget the device.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.Future<ForgotPasswordResult> forgotPasswordAsync(ForgotPasswordRequest forgotPasswordRequest)
Retrieves the password for the specified client ID or username.
forgotPasswordRequest - Represents the request to reset a user's password.Future<ForgotPasswordResult> forgotPasswordAsync(ForgotPasswordRequest forgotPasswordRequest, AsyncHandler<ForgotPasswordRequest,ForgotPasswordResult> asyncHandler)
Retrieves the password for the specified client ID or username.
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.Future<GetCSVHeaderResult> getCSVHeaderAsync(GetCSVHeaderRequest getCSVHeaderRequest)
Gets the header information for the .csv file to be used as input for the user import job.
getCSVHeaderRequest - Represents the request to get the header information for the .csv file for the user import job.Future<GetCSVHeaderResult> getCSVHeaderAsync(GetCSVHeaderRequest getCSVHeaderRequest, AsyncHandler<GetCSVHeaderRequest,GetCSVHeaderResult> asyncHandler)
Gets the header information for the .csv file to be used as input for the user import job.
getCSVHeaderRequest - Represents the request to get the header information for the .csv file for the user import job.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.Future<GetDeviceResult> getDeviceAsync(GetDeviceRequest getDeviceRequest)
Gets the device.
getDeviceRequest - Represents the request to get the device.Future<GetDeviceResult> getDeviceAsync(GetDeviceRequest getDeviceRequest, AsyncHandler<GetDeviceRequest,GetDeviceResult> asyncHandler)
Gets the device.
getDeviceRequest - Represents the request to get the device.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.Future<GetUserResult> getUserAsync(GetUserRequest getUserRequest)
Gets the user attributes and metadata for a user.
getUserRequest - Represents the request to get information about the user.Future<GetUserResult> getUserAsync(GetUserRequest getUserRequest, AsyncHandler<GetUserRequest,GetUserResult> asyncHandler)
Gets the user attributes and metadata for a user.
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.Future<GetUserAttributeVerificationCodeResult> getUserAttributeVerificationCodeAsync(GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest)
Gets the user attribute verification code for the specified attribute name.
getUserAttributeVerificationCodeRequest - Represents the request to get user attribute verification.Future<GetUserAttributeVerificationCodeResult> getUserAttributeVerificationCodeAsync(GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest, AsyncHandler<GetUserAttributeVerificationCodeRequest,GetUserAttributeVerificationCodeResult> asyncHandler)
Gets the user attribute verification code for the specified attribute name.
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.Future<GlobalSignOutResult> globalSignOutAsync(GlobalSignOutRequest globalSignOutRequest)
Signs out users from all devices.
globalSignOutRequest - Represents the request to sign out all devices.Future<GlobalSignOutResult> globalSignOutAsync(GlobalSignOutRequest globalSignOutRequest, AsyncHandler<GlobalSignOutRequest,GlobalSignOutResult> asyncHandler)
Signs out users from all devices.
globalSignOutRequest - Represents the request to sign out all devices.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.Future<InitiateAuthResult> initiateAuthAsync(InitiateAuthRequest initiateAuthRequest)
Initiates the authentication flow.
initiateAuthRequest - Initiates the authentication request.Future<InitiateAuthResult> initiateAuthAsync(InitiateAuthRequest initiateAuthRequest, AsyncHandler<InitiateAuthRequest,InitiateAuthResult> asyncHandler)
Initiates the authentication flow.
initiateAuthRequest - Initiates the authentication request.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.Future<ListDevicesResult> listDevicesAsync(ListDevicesRequest listDevicesRequest)
Lists the devices.
listDevicesRequest - Represents the request to list the devices.Future<ListDevicesResult> listDevicesAsync(ListDevicesRequest listDevicesRequest, AsyncHandler<ListDevicesRequest,ListDevicesResult> asyncHandler)
Lists the devices.
listDevicesRequest - Represents the request to list the devices.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.Future<ListUserImportJobsResult> listUserImportJobsAsync(ListUserImportJobsRequest listUserImportJobsRequest)
Lists the user import jobs.
listUserImportJobsRequest - Represents the request to list the user import jobs.Future<ListUserImportJobsResult> listUserImportJobsAsync(ListUserImportJobsRequest listUserImportJobsRequest, AsyncHandler<ListUserImportJobsRequest,ListUserImportJobsResult> asyncHandler)
Lists the user import jobs.
listUserImportJobsRequest - Represents the request to list the user import jobs.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.Future<ListUserPoolClientsResult> listUserPoolClientsAsync(ListUserPoolClientsRequest listUserPoolClientsRequest)
Lists the clients that have been created for the specified user pool.
listUserPoolClientsRequest - Represents the request to list the user pool clients.Future<ListUserPoolClientsResult> listUserPoolClientsAsync(ListUserPoolClientsRequest listUserPoolClientsRequest, AsyncHandler<ListUserPoolClientsRequest,ListUserPoolClientsResult> asyncHandler)
Lists the clients that have been created for the specified user pool.
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.Future<ListUserPoolsResult> listUserPoolsAsync(ListUserPoolsRequest listUserPoolsRequest)
Lists the user pools associated with an AWS account.
listUserPoolsRequest - Represents the request to list user pools.Future<ListUserPoolsResult> listUserPoolsAsync(ListUserPoolsRequest listUserPoolsRequest, AsyncHandler<ListUserPoolsRequest,ListUserPoolsResult> asyncHandler)
Lists the user pools associated with an AWS account.
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.Future<ListUsersResult> listUsersAsync(ListUsersRequest listUsersRequest)
Lists the users in the Amazon Cognito user pool.
listUsersRequest - Represents the request to list users.Future<ListUsersResult> listUsersAsync(ListUsersRequest listUsersRequest, AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler)
Lists the users in the Amazon Cognito user pool.
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.Future<ResendConfirmationCodeResult> resendConfirmationCodeAsync(ResendConfirmationCodeRequest resendConfirmationCodeRequest)
Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
resendConfirmationCodeRequest - Represents the request to resend the confirmation code.Future<ResendConfirmationCodeResult> resendConfirmationCodeAsync(ResendConfirmationCodeRequest resendConfirmationCodeRequest, AsyncHandler<ResendConfirmationCodeRequest,ResendConfirmationCodeResult> asyncHandler)
Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
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.Future<RespondToAuthChallengeResult> respondToAuthChallengeAsync(RespondToAuthChallengeRequest respondToAuthChallengeRequest)
Responds to the authentication challenge.
respondToAuthChallengeRequest - The request to respond to an authentication challenge.Future<RespondToAuthChallengeResult> respondToAuthChallengeAsync(RespondToAuthChallengeRequest respondToAuthChallengeRequest, AsyncHandler<RespondToAuthChallengeRequest,RespondToAuthChallengeResult> asyncHandler)
Responds to the authentication challenge.
respondToAuthChallengeRequest - The request to respond to an authentication challenge.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.Future<SetUserSettingsResult> setUserSettingsAsync(SetUserSettingsRequest setUserSettingsRequest)
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.
setUserSettingsRequest - Represents the request to set user settings.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.
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.Future<SignUpResult> signUpAsync(SignUpRequest signUpRequest)
Registers the user in the specified user pool and creates a user name, password, and user attributes.
signUpRequest - Represents the request to register a user.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.
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.Future<StartUserImportJobResult> startUserImportJobAsync(StartUserImportJobRequest startUserImportJobRequest)
Starts the user import.
startUserImportJobRequest - Represents the request to start the user import job.Future<StartUserImportJobResult> startUserImportJobAsync(StartUserImportJobRequest startUserImportJobRequest, AsyncHandler<StartUserImportJobRequest,StartUserImportJobResult> asyncHandler)
Starts the user import.
startUserImportJobRequest - Represents the request to start the user import job.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.Future<StopUserImportJobResult> stopUserImportJobAsync(StopUserImportJobRequest stopUserImportJobRequest)
Stops the user import job.
stopUserImportJobRequest - Represents the request to stop the user import job.Future<StopUserImportJobResult> stopUserImportJobAsync(StopUserImportJobRequest stopUserImportJobRequest, AsyncHandler<StopUserImportJobRequest,StopUserImportJobResult> asyncHandler)
Stops the user import job.
stopUserImportJobRequest - Represents the request to stop the user import job.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.Future<UpdateDeviceStatusResult> updateDeviceStatusAsync(UpdateDeviceStatusRequest updateDeviceStatusRequest)
Updates the device status.
updateDeviceStatusRequest - Represents the request to update the device status.Future<UpdateDeviceStatusResult> updateDeviceStatusAsync(UpdateDeviceStatusRequest updateDeviceStatusRequest, AsyncHandler<UpdateDeviceStatusRequest,UpdateDeviceStatusResult> asyncHandler)
Updates the device status.
updateDeviceStatusRequest - Represents the request to update the device status.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.Future<UpdateUserAttributesResult> updateUserAttributesAsync(UpdateUserAttributesRequest updateUserAttributesRequest)
Allows a user to update a specific attribute (one at a time).
updateUserAttributesRequest - Represents the request to update user attributes.Future<UpdateUserAttributesResult> updateUserAttributesAsync(UpdateUserAttributesRequest updateUserAttributesRequest, AsyncHandler<UpdateUserAttributesRequest,UpdateUserAttributesResult> asyncHandler)
Allows a user to update a specific attribute (one at a time).
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.Future<UpdateUserPoolResult> updateUserPoolAsync(UpdateUserPoolRequest updateUserPoolRequest)
Updates the specified user pool with the specified attributes.
updateUserPoolRequest - Represents the request to update the user pool.Future<UpdateUserPoolResult> updateUserPoolAsync(UpdateUserPoolRequest updateUserPoolRequest, AsyncHandler<UpdateUserPoolRequest,UpdateUserPoolResult> asyncHandler)
Updates the specified user pool with the specified attributes.
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.Future<UpdateUserPoolClientResult> updateUserPoolClientAsync(UpdateUserPoolClientRequest updateUserPoolClientRequest)
Allows the developer to update the specified user pool client and password policy.
updateUserPoolClientRequest - Represents the request to update the user pool client.Future<UpdateUserPoolClientResult> updateUserPoolClientAsync(UpdateUserPoolClientRequest updateUserPoolClientRequest, AsyncHandler<UpdateUserPoolClientRequest,UpdateUserPoolClientResult> asyncHandler)
Allows the developer to update the specified user pool client and password policy.
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.Future<VerifyUserAttributeResult> verifyUserAttributeAsync(VerifyUserAttributeRequest verifyUserAttributeRequest)
Verifies the specified user attributes in the user pool.
verifyUserAttributeRequest - Represents the request to verify user attributes.Future<VerifyUserAttributeResult> verifyUserAttributeAsync(VerifyUserAttributeRequest verifyUserAttributeRequest, AsyncHandler<VerifyUserAttributeRequest,VerifyUserAttributeResult> asyncHandler)
Verifies the specified user attributes in the user pool.
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.Copyright © 2016. All rights reserved.