com.amazonaws.services.cognitoidp.AWSCognitoIdentityProviderAsync Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-cognitoidp Show documentation
Show all versions of aws-java-sdk-cognitoidp Show documentation
The AWS Java SDK for Amazon Cognito Identity Provider Service module holds the client classes that are used for communicating with Amazon Cognito Identity Provider Service.
/*
* Copyright 2010-2016 Amazon.com, Inc. or its affiliates. All Rights
* Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.cognitoidp;
import com.amazonaws.services.cognitoidp.model.*;
/**
* Interface for accessing Amazon Cognito Identity Provider asynchronously. Each
* asynchronous method will return a Java Future object representing the
* asynchronous operation; overloads which accept an {@code 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.
*
*/
public interface AWSCognitoIdentityProviderAsync extends
AWSCognitoIdentityProvider {
/**
*
* Adds additional user attributes to the user pool schema.
*
*
* @param addCustomAttributesRequest
* Represents the request to add custom attributes.
* @return A Java Future containing the result of the AddCustomAttributes
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsync.AddCustomAttributes
*/
java.util.concurrent.Future addCustomAttributesAsync(
AddCustomAttributesRequest addCustomAttributesRequest);
/**
*
* Adds additional user attributes to the user pool schema.
*
*
* @param addCustomAttributesRequest
* Represents the request to add custom attributes.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the AddCustomAttributes
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsyncHandler.AddCustomAttributes
*/
java.util.concurrent.Future addCustomAttributesAsync(
AddCustomAttributesRequest addCustomAttributesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Confirms user registration as an admin without using a confirmation code.
* Works on any user.
*
*
* @param adminConfirmSignUpRequest
* Represents the request to confirm user registration.
* @return A Java Future containing the result of the AdminConfirmSignUp
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsync.AdminConfirmSignUp
*/
java.util.concurrent.Future adminConfirmSignUpAsync(
AdminConfirmSignUpRequest adminConfirmSignUpRequest);
/**
*
* Confirms user registration as an admin without using a confirmation code.
* Works on any user.
*
*
* @param adminConfirmSignUpRequest
* Represents the request to confirm user registration.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the AdminConfirmSignUp
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsyncHandler.AdminConfirmSignUp
*/
java.util.concurrent.Future adminConfirmSignUpAsync(
AdminConfirmSignUpRequest adminConfirmSignUpRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes a user as an administrator. Works on any user.
*
*
* @param adminDeleteUserRequest
* Represents the request to delete a user as an administrator.
* @return A Java Future containing the result of the AdminDeleteUser
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsync.AdminDeleteUser
*/
java.util.concurrent.Future adminDeleteUserAsync(
AdminDeleteUserRequest adminDeleteUserRequest);
/**
*
* Deletes a user as an administrator. Works on any user.
*
*
* @param adminDeleteUserRequest
* Represents the request to delete a user as an administrator.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the AdminDeleteUser
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsyncHandler.AdminDeleteUser
*/
java.util.concurrent.Future adminDeleteUserAsync(
AdminDeleteUserRequest adminDeleteUserRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes the user attributes in a user pool as an administrator. Works on
* any user.
*
*
* @param adminDeleteUserAttributesRequest
* Represents the request to delete user attributes as an
* administrator.
* @return A Java Future containing the result of the
* AdminDeleteUserAttributes operation returned by the service.
* @sample AWSCognitoIdentityProviderAsync.AdminDeleteUserAttributes
*/
java.util.concurrent.Future adminDeleteUserAttributesAsync(
AdminDeleteUserAttributesRequest adminDeleteUserAttributesRequest);
/**
*
* Deletes the user attributes in a user pool as an administrator. Works on
* any user.
*
*
* @param adminDeleteUserAttributesRequest
* Represents the request to delete user attributes as an
* administrator.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the
* AdminDeleteUserAttributes operation returned by the service.
* @sample AWSCognitoIdentityProviderAsyncHandler.AdminDeleteUserAttributes
*/
java.util.concurrent.Future adminDeleteUserAttributesAsync(
AdminDeleteUserAttributesRequest adminDeleteUserAttributesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Disables the specified user as an administrator. Works on any user.
*
*
* @param adminDisableUserRequest
* Represents the request to disable any user as an administrator.
* @return A Java Future containing the result of the AdminDisableUser
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsync.AdminDisableUser
*/
java.util.concurrent.Future adminDisableUserAsync(
AdminDisableUserRequest adminDisableUserRequest);
/**
*
* Disables the specified user as an administrator. Works on any user.
*
*
* @param adminDisableUserRequest
* Represents the request to disable any user as an administrator.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the AdminDisableUser
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsyncHandler.AdminDisableUser
*/
java.util.concurrent.Future adminDisableUserAsync(
AdminDisableUserRequest adminDisableUserRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Enables the specified user as an administrator. Works on any user.
*
*
* @param adminEnableUserRequest
* Represents the request that enables the user as an administrator.
* @return A Java Future containing the result of the AdminEnableUser
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsync.AdminEnableUser
*/
java.util.concurrent.Future adminEnableUserAsync(
AdminEnableUserRequest adminEnableUserRequest);
/**
*
* Enables the specified user as an administrator. Works on any user.
*
*
* @param adminEnableUserRequest
* Represents the request that enables the user as an administrator.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the AdminEnableUser
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsyncHandler.AdminEnableUser
*/
java.util.concurrent.Future adminEnableUserAsync(
AdminEnableUserRequest adminEnableUserRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets the specified user by user name in a user pool as an administrator.
* Works on any user.
*
*
* @param adminGetUserRequest
* Represents the request to get the specified user as an
* administrator.
* @return A Java Future containing the result of the AdminGetUser operation
* returned by the service.
* @sample AWSCognitoIdentityProviderAsync.AdminGetUser
*/
java.util.concurrent.Future adminGetUserAsync(
AdminGetUserRequest adminGetUserRequest);
/**
*
* Gets the specified user by user name in a user pool as an administrator.
* Works on any user.
*
*
* @param adminGetUserRequest
* Represents the request to get the specified user as an
* administrator.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the AdminGetUser operation
* returned by the service.
* @sample AWSCognitoIdentityProviderAsyncHandler.AdminGetUser
*/
java.util.concurrent.Future adminGetUserAsync(
AdminGetUserRequest adminGetUserRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Resets the specified user's password in a user pool as an administrator.
* Works on any user.
*
*
* @param adminResetUserPasswordRequest
* Represents the request to reset a user's password as an
* administrator.
* @return A Java Future containing the result of the AdminResetUserPassword
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsync.AdminResetUserPassword
*/
java.util.concurrent.Future adminResetUserPasswordAsync(
AdminResetUserPasswordRequest adminResetUserPasswordRequest);
/**
*
* Resets the specified user's password in a user pool as an administrator.
* Works on any user.
*
*
* @param adminResetUserPasswordRequest
* Represents the request to reset a user's password as an
* administrator.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the AdminResetUserPassword
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsyncHandler.AdminResetUserPassword
*/
java.util.concurrent.Future adminResetUserPasswordAsync(
AdminResetUserPasswordRequest adminResetUserPasswordRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Sets all the user settings for a specified user name. Works on any user.
*
*
* @param adminSetUserSettingsRequest
* Represents the request to set user settings as an administrator.
* @return A Java Future containing the result of the AdminSetUserSettings
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsync.AdminSetUserSettings
*/
java.util.concurrent.Future adminSetUserSettingsAsync(
AdminSetUserSettingsRequest adminSetUserSettingsRequest);
/**
*
* Sets all the user settings for a specified user name. Works on any user.
*
*
* @param adminSetUserSettingsRequest
* Represents the request to set user settings as an administrator.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the AdminSetUserSettings
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsyncHandler.AdminSetUserSettings
*/
java.util.concurrent.Future adminSetUserSettingsAsync(
AdminSetUserSettingsRequest adminSetUserSettingsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates the specified user's attributes, including developer attributes,
* as an administrator. Works on any user.
*
*
* @param adminUpdateUserAttributesRequest
* Represents the request to update the user's attributes as an
* administrator.
* @return A Java Future containing the result of the
* AdminUpdateUserAttributes operation returned by the service.
* @sample AWSCognitoIdentityProviderAsync.AdminUpdateUserAttributes
*/
java.util.concurrent.Future adminUpdateUserAttributesAsync(
AdminUpdateUserAttributesRequest adminUpdateUserAttributesRequest);
/**
*
* Updates the specified user's attributes, including developer attributes,
* as an administrator. Works on any user.
*
*
* @param adminUpdateUserAttributesRequest
* Represents the request to update the user's attributes as an
* administrator.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the
* AdminUpdateUserAttributes operation returned by the service.
* @sample AWSCognitoIdentityProviderAsyncHandler.AdminUpdateUserAttributes
*/
java.util.concurrent.Future adminUpdateUserAttributesAsync(
AdminUpdateUserAttributesRequest adminUpdateUserAttributesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Changes the password for a specified user in a user pool.
*
*
* @param changePasswordRequest
* Represents the request to change a user password.
* @return A Java Future containing the result of the ChangePassword
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsync.ChangePassword
*/
java.util.concurrent.Future changePasswordAsync(
ChangePasswordRequest changePasswordRequest);
/**
*
* Changes the password for a specified user in a user pool.
*
*
* @param changePasswordRequest
* Represents the request to change a user password.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ChangePassword
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsyncHandler.ChangePassword
*/
java.util.concurrent.Future changePasswordAsync(
ChangePasswordRequest changePasswordRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Allows a user to enter a code provided when they reset their password to
* update their password.
*
*
* @param confirmForgotPasswordRequest
* The request representing the confirmation for a password reset.
* @return A Java Future containing the result of the ConfirmForgotPassword
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsync.ConfirmForgotPassword
*/
java.util.concurrent.Future confirmForgotPasswordAsync(
ConfirmForgotPasswordRequest confirmForgotPasswordRequest);
/**
*
* Allows a user to enter a code provided when they reset their password to
* update their password.
*
*
* @param confirmForgotPasswordRequest
* The request representing the confirmation for a password reset.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ConfirmForgotPassword
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsyncHandler.ConfirmForgotPassword
*/
java.util.concurrent.Future confirmForgotPasswordAsync(
ConfirmForgotPasswordRequest confirmForgotPasswordRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Confirms registration of a user and handles the existing alias from a
* previous user.
*
*
* @param confirmSignUpRequest
* Represents the request to confirm registration of a user.
* @return A Java Future containing the result of the ConfirmSignUp
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsync.ConfirmSignUp
*/
java.util.concurrent.Future confirmSignUpAsync(
ConfirmSignUpRequest confirmSignUpRequest);
/**
*
* Confirms registration of a user and handles the existing alias from a
* previous user.
*
*
* @param confirmSignUpRequest
* Represents the request to confirm registration of a user.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ConfirmSignUp
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsyncHandler.ConfirmSignUp
*/
java.util.concurrent.Future confirmSignUpAsync(
ConfirmSignUpRequest confirmSignUpRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates a new Amazon Cognito user pool and sets the password policy for
* the pool.
*
*
* @param createUserPoolRequest
* Represents the request to create a user pool.
* @return A Java Future containing the result of the CreateUserPool
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsync.CreateUserPool
*/
java.util.concurrent.Future createUserPoolAsync(
CreateUserPoolRequest createUserPoolRequest);
/**
*
* Creates a new Amazon Cognito user pool and sets the password policy for
* the pool.
*
*
* @param createUserPoolRequest
* Represents the request to create a user pool.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateUserPool
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsyncHandler.CreateUserPool
*/
java.util.concurrent.Future createUserPoolAsync(
CreateUserPoolRequest createUserPoolRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates the user pool client.
*
*
* @param createUserPoolClientRequest
* Represents the request to create a user pool client.
* @return A Java Future containing the result of the CreateUserPoolClient
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsync.CreateUserPoolClient
*/
java.util.concurrent.Future createUserPoolClientAsync(
CreateUserPoolClientRequest createUserPoolClientRequest);
/**
*
* Creates the user pool client.
*
*
* @param createUserPoolClientRequest
* Represents the request to create a user pool client.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateUserPoolClient
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsyncHandler.CreateUserPoolClient
*/
java.util.concurrent.Future createUserPoolClientAsync(
CreateUserPoolClientRequest createUserPoolClientRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Allows a user to delete one's self.
*
*
* @param deleteUserRequest
* Represents the request to delete a user.
* @return A Java Future containing the result of the DeleteUser operation
* returned by the service.
* @sample AWSCognitoIdentityProviderAsync.DeleteUser
*/
java.util.concurrent.Future deleteUserAsync(
DeleteUserRequest deleteUserRequest);
/**
*
* Allows a user to delete one's self.
*
*
* @param deleteUserRequest
* Represents the request to delete a user.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteUser operation
* returned by the service.
* @sample AWSCognitoIdentityProviderAsyncHandler.DeleteUser
*/
java.util.concurrent.Future deleteUserAsync(
DeleteUserRequest deleteUserRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes the attributes for a user.
*
*
* @param deleteUserAttributesRequest
* Represents the request to delete user attributes.
* @return A Java Future containing the result of the DeleteUserAttributes
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsync.DeleteUserAttributes
*/
java.util.concurrent.Future deleteUserAttributesAsync(
DeleteUserAttributesRequest deleteUserAttributesRequest);
/**
*
* Deletes the attributes for a user.
*
*
* @param deleteUserAttributesRequest
* Represents the request to delete user attributes.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteUserAttributes
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsyncHandler.DeleteUserAttributes
*/
java.util.concurrent.Future deleteUserAttributesAsync(
DeleteUserAttributesRequest deleteUserAttributesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes the specified Amazon Cognito user pool.
*
*
* @param deleteUserPoolRequest
* Represents the request to delete a user pool.
* @return A Java Future containing the result of the DeleteUserPool
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsync.DeleteUserPool
*/
java.util.concurrent.Future deleteUserPoolAsync(
DeleteUserPoolRequest deleteUserPoolRequest);
/**
*
* Deletes the specified Amazon Cognito user pool.
*
*
* @param deleteUserPoolRequest
* Represents the request to delete a user pool.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteUserPool
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsyncHandler.DeleteUserPool
*/
java.util.concurrent.Future deleteUserPoolAsync(
DeleteUserPoolRequest deleteUserPoolRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Allows the developer to delete the user pool client.
*
*
* @param deleteUserPoolClientRequest
* Represents the request to delete a user pool client.
* @return A Java Future containing the result of the DeleteUserPoolClient
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsync.DeleteUserPoolClient
*/
java.util.concurrent.Future deleteUserPoolClientAsync(
DeleteUserPoolClientRequest deleteUserPoolClientRequest);
/**
*
* Allows the developer to delete the user pool client.
*
*
* @param deleteUserPoolClientRequest
* Represents the request to delete a user pool client.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteUserPoolClient
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsyncHandler.DeleteUserPoolClient
*/
java.util.concurrent.Future deleteUserPoolClientAsync(
DeleteUserPoolClientRequest deleteUserPoolClientRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns the configuration information and metadata of the specified user
* pool.
*
*
* @param describeUserPoolRequest
* Represents the request to describe the user pool.
* @return A Java Future containing the result of the DescribeUserPool
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsync.DescribeUserPool
*/
java.util.concurrent.Future describeUserPoolAsync(
DescribeUserPoolRequest describeUserPoolRequest);
/**
*
* Returns the configuration information and metadata of the specified user
* pool.
*
*
* @param describeUserPoolRequest
* Represents the request to describe the user pool.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeUserPool
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsyncHandler.DescribeUserPool
*/
java.util.concurrent.Future describeUserPoolAsync(
DescribeUserPoolRequest describeUserPoolRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Client method for returning the configuration information and metadata of
* the specified user pool client.
*
*
* @param describeUserPoolClientRequest
* Represents the request to describe a user pool client.
* @return A Java Future containing the result of the DescribeUserPoolClient
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsync.DescribeUserPoolClient
*/
java.util.concurrent.Future describeUserPoolClientAsync(
DescribeUserPoolClientRequest describeUserPoolClientRequest);
/**
*
* Client method for returning the configuration information and metadata of
* the specified user pool client.
*
*
* @param describeUserPoolClientRequest
* Represents the request to describe a user pool client.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeUserPoolClient
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsyncHandler.DescribeUserPoolClient
*/
java.util.concurrent.Future describeUserPoolClientAsync(
DescribeUserPoolClientRequest describeUserPoolClientRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves the password for the specified client ID or username.
*
*
* @param forgotPasswordRequest
* Represents the request to reset a user's password.
* @return A Java Future containing the result of the ForgotPassword
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsync.ForgotPassword
*/
java.util.concurrent.Future forgotPasswordAsync(
ForgotPasswordRequest forgotPasswordRequest);
/**
*
* Retrieves the password for the specified client ID or username.
*
*
* @param forgotPasswordRequest
* Represents the request to reset a user's password.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ForgotPassword
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsyncHandler.ForgotPassword
*/
java.util.concurrent.Future forgotPasswordAsync(
ForgotPasswordRequest forgotPasswordRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets the user attributes and metadata for a user.
*
*
* @param getUserRequest
* Represents the request to get information about the user.
* @return A Java Future containing the result of the GetUser operation
* returned by the service.
* @sample AWSCognitoIdentityProviderAsync.GetUser
*/
java.util.concurrent.Future getUserAsync(
GetUserRequest getUserRequest);
/**
*
* Gets the user attributes and metadata for a user.
*
*
* @param getUserRequest
* Represents the request to get information about the user.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetUser operation
* returned by the service.
* @sample AWSCognitoIdentityProviderAsyncHandler.GetUser
*/
java.util.concurrent.Future getUserAsync(
GetUserRequest getUserRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets the user attribute verification code for the specified attribute
* name.
*
*
* @param getUserAttributeVerificationCodeRequest
* Represents the request to get user attribute verification.
* @return A Java Future containing the result of the
* GetUserAttributeVerificationCode operation returned by the
* service.
* @sample AWSCognitoIdentityProviderAsync.GetUserAttributeVerificationCode
*/
java.util.concurrent.Future getUserAttributeVerificationCodeAsync(
GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest);
/**
*
* Gets the user attribute verification code for the specified attribute
* name.
*
*
* @param getUserAttributeVerificationCodeRequest
* Represents the request to get user attribute verification.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the
* GetUserAttributeVerificationCode operation returned by the
* service.
* @sample
* AWSCognitoIdentityProviderAsyncHandler.GetUserAttributeVerificationCode
*/
java.util.concurrent.Future getUserAttributeVerificationCodeAsync(
GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists the clients that have been created for the specified user pool.
*
*
* @param listUserPoolClientsRequest
* Represents the request to list the user pool clients.
* @return A Java Future containing the result of the ListUserPoolClients
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsync.ListUserPoolClients
*/
java.util.concurrent.Future listUserPoolClientsAsync(
ListUserPoolClientsRequest listUserPoolClientsRequest);
/**
*
* Lists the clients that have been created for the specified user pool.
*
*
* @param listUserPoolClientsRequest
* Represents the request to list the user pool clients.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListUserPoolClients
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsyncHandler.ListUserPoolClients
*/
java.util.concurrent.Future listUserPoolClientsAsync(
ListUserPoolClientsRequest listUserPoolClientsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists the user pools associated with an AWS account.
*
*
* @param listUserPoolsRequest
* Represents the request to list user pools.
* @return A Java Future containing the result of the ListUserPools
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsync.ListUserPools
*/
java.util.concurrent.Future listUserPoolsAsync(
ListUserPoolsRequest listUserPoolsRequest);
/**
*
* Lists the user pools associated with an AWS account.
*
*
* @param listUserPoolsRequest
* Represents the request to list user pools.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListUserPools
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsyncHandler.ListUserPools
*/
java.util.concurrent.Future listUserPoolsAsync(
ListUserPoolsRequest listUserPoolsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists the users in the Amazon Cognito user pool.
*
*
* @param listUsersRequest
* Represents the request to list users.
* @return A Java Future containing the result of the ListUsers operation
* returned by the service.
* @sample AWSCognitoIdentityProviderAsync.ListUsers
*/
java.util.concurrent.Future listUsersAsync(
ListUsersRequest listUsersRequest);
/**
*
* Lists the users in the Amazon Cognito user pool.
*
*
* @param listUsersRequest
* Represents the request to list users.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListUsers operation
* returned by the service.
* @sample AWSCognitoIdentityProviderAsyncHandler.ListUsers
*/
java.util.concurrent.Future listUsersAsync(
ListUsersRequest listUsersRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Resends the confirmation (for confirmation of registration) to a specific
* user in the user pool.
*
*
* @param resendConfirmationCodeRequest
* Represents the request to resend the confirmation code.
* @return A Java Future containing the result of the ResendConfirmationCode
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsync.ResendConfirmationCode
*/
java.util.concurrent.Future resendConfirmationCodeAsync(
ResendConfirmationCodeRequest resendConfirmationCodeRequest);
/**
*
* Resends the confirmation (for confirmation of registration) to a specific
* user in the user pool.
*
*
* @param resendConfirmationCodeRequest
* Represents the request to resend the confirmation code.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ResendConfirmationCode
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsyncHandler.ResendConfirmationCode
*/
java.util.concurrent.Future resendConfirmationCodeAsync(
ResendConfirmationCodeRequest resendConfirmationCodeRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param setUserSettingsRequest
* Represents the request to set user settings.
* @return A Java Future containing the result of the SetUserSettings
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsync.SetUserSettings
*/
java.util.concurrent.Future 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.
*
*
* @param setUserSettingsRequest
* Represents the request to set user settings.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the SetUserSettings
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsyncHandler.SetUserSettings
*/
java.util.concurrent.Future setUserSettingsAsync(
SetUserSettingsRequest setUserSettingsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Registers the user in the specified user pool and creates a user name,
* password, and user attributes.
*
*
* @param signUpRequest
* Represents the request to register a user.
* @return A Java Future containing the result of the SignUp operation
* returned by the service.
* @sample AWSCognitoIdentityProviderAsync.SignUp
*/
java.util.concurrent.Future signUpAsync(
SignUpRequest signUpRequest);
/**
*
* Registers the user in the specified user pool and creates a user name,
* password, and user attributes.
*
*
* @param signUpRequest
* Represents the request to register a user.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the SignUp operation
* returned by the service.
* @sample AWSCognitoIdentityProviderAsyncHandler.SignUp
*/
java.util.concurrent.Future signUpAsync(
SignUpRequest signUpRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Allows a user to update a specific attribute (one at a time).
*
*
* @param updateUserAttributesRequest
* Represents the request to update user attributes.
* @return A Java Future containing the result of the UpdateUserAttributes
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsync.UpdateUserAttributes
*/
java.util.concurrent.Future updateUserAttributesAsync(
UpdateUserAttributesRequest updateUserAttributesRequest);
/**
*
* Allows a user to update a specific attribute (one at a time).
*
*
* @param updateUserAttributesRequest
* Represents the request to update user attributes.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UpdateUserAttributes
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsyncHandler.UpdateUserAttributes
*/
java.util.concurrent.Future updateUserAttributesAsync(
UpdateUserAttributesRequest updateUserAttributesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates the specified user pool with the specified attributes.
*
*
* @param updateUserPoolRequest
* Represents the request to update the user pool.
* @return A Java Future containing the result of the UpdateUserPool
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsync.UpdateUserPool
*/
java.util.concurrent.Future updateUserPoolAsync(
UpdateUserPoolRequest updateUserPoolRequest);
/**
*
* Updates the specified user pool with the specified attributes.
*
*
* @param updateUserPoolRequest
* Represents the request to update the user pool.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UpdateUserPool
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsyncHandler.UpdateUserPool
*/
java.util.concurrent.Future updateUserPoolAsync(
UpdateUserPoolRequest updateUserPoolRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Allows the developer to update the specified user pool client and
* password policy.
*
*
* @param updateUserPoolClientRequest
* Represents the request to update the user pool client.
* @return A Java Future containing the result of the UpdateUserPoolClient
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsync.UpdateUserPoolClient
*/
java.util.concurrent.Future updateUserPoolClientAsync(
UpdateUserPoolClientRequest updateUserPoolClientRequest);
/**
*
* Allows the developer to update the specified user pool client and
* password policy.
*
*
* @param updateUserPoolClientRequest
* Represents the request to update the user pool client.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UpdateUserPoolClient
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsyncHandler.UpdateUserPoolClient
*/
java.util.concurrent.Future updateUserPoolClientAsync(
UpdateUserPoolClientRequest updateUserPoolClientRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Verifies the specified user attributes in the user pool.
*
*
* @param verifyUserAttributeRequest
* Represents the request to verify user attributes.
* @return A Java Future containing the result of the VerifyUserAttribute
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsync.VerifyUserAttribute
*/
java.util.concurrent.Future verifyUserAttributeAsync(
VerifyUserAttributeRequest verifyUserAttributeRequest);
/**
*
* Verifies the specified user attributes in the user pool.
*
*
* @param verifyUserAttributeRequest
* Represents the request to verify user attributes.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the VerifyUserAttribute
* operation returned by the service.
* @sample AWSCognitoIdentityProviderAsyncHandler.VerifyUserAttribute
*/
java.util.concurrent.Future verifyUserAttributeAsync(
VerifyUserAttributeRequest verifyUserAttributeRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy