Package com.amazonaws.services.cognitoidp

Class AWSCognitoIdentityProviderAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.cognitoidp.AWSCognitoIdentityProviderClient

com.amazonaws.services.cognitoidp.AWSCognitoIdentityProviderAsyncClient

All Implemented Interfaces:

AWSCognitoIdentityProvider, AWSCognitoIdentityProviderAsync

@ThreadSafe
public class AWSCognitoIdentityProviderAsyncClient
extends AWSCognitoIdentityProviderClient
implements AWSCognitoIdentityProviderAsync

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 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.

Field Summary

Fields inherited from class com.amazonaws.services.cognitoidp.AWSCognitoIdentityProviderClient

configFactory

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor	Description
AWSCognitoIdentityProviderAsyncClient()	Constructs a new asynchronous client to invoke service methods on Amazon Cognito Identity Provider.
AWSCognitoIdentityProviderAsyncClient(AWSCredentials awsCredentials)	Constructs a new asynchronous client to invoke service methods on Amazon Cognito Identity Provider using the specified AWS account credentials.
AWSCognitoIdentityProviderAsyncClient(AWSCredentialsProvider awsCredentialsProvider)	Constructs a new asynchronous client to invoke service methods on Amazon Cognito Identity Provider using the specified AWS account credentials provider.
AWSCognitoIdentityProviderAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)	Constructs a new asynchronous client to invoke service methods on Amazon Cognito Identity Provider using the provided AWS account credentials provider and client configuration options.
AWSCognitoIdentityProviderAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)	Constructs a new asynchronous client to invoke service methods on Amazon Cognito Identity Provider using the specified AWS account credentials provider, executor service, and client configuration options.
AWSCognitoIdentityProviderAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)	Constructs a new asynchronous client to invoke service methods on Amazon Cognito Identity Provider using the specified AWS account credentials provider and executor service.
AWSCognitoIdentityProviderAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)	Constructs a new asynchronous client to invoke service methods on Amazon Cognito Identity Provider using the specified AWS account credentials, executor service, and client configuration options.
AWSCognitoIdentityProviderAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)	Constructs a new asynchronous client to invoke service methods on Amazon Cognito Identity Provider using the specified AWS account credentials and executor service.
AWSCognitoIdentityProviderAsyncClient(ClientConfiguration clientConfiguration)	Constructs a new asynchronous client to invoke service methods on Amazon Cognito Identity Provider.

Method Summary

Modifier and Type	Method	Description
Future<AddCustomAttributesResult>	addCustomAttributesAsync(AddCustomAttributesRequest request)	Adds additional user attributes to the user pool schema.
Future<AddCustomAttributesResult>	addCustomAttributesAsync(AddCustomAttributesRequest request, AsyncHandler<AddCustomAttributesRequest,AddCustomAttributesResult> asyncHandler)	Adds additional user attributes to the user pool schema.
Future<AdminConfirmSignUpResult>	adminConfirmSignUpAsync(AdminConfirmSignUpRequest request)	Confirms user registration as an admin without using a confirmation code.
Future<AdminConfirmSignUpResult>	adminConfirmSignUpAsync(AdminConfirmSignUpRequest request, AsyncHandler<AdminConfirmSignUpRequest,AdminConfirmSignUpResult> asyncHandler)	Confirms user registration as an admin without using a confirmation code.
Future<AdminDeleteUserResult>	adminDeleteUserAsync(AdminDeleteUserRequest request)	Deletes a user as an administrator.
Future<AdminDeleteUserResult>	adminDeleteUserAsync(AdminDeleteUserRequest request, AsyncHandler<AdminDeleteUserRequest,AdminDeleteUserResult> asyncHandler)	Deletes a user as an administrator.
Future<AdminDeleteUserAttributesResult>	adminDeleteUserAttributesAsync(AdminDeleteUserAttributesRequest request)	Deletes the user attributes in a user pool as an administrator.
Future<AdminDeleteUserAttributesResult>	adminDeleteUserAttributesAsync(AdminDeleteUserAttributesRequest request, AsyncHandler<AdminDeleteUserAttributesRequest,AdminDeleteUserAttributesResult> asyncHandler)	Deletes the user attributes in a user pool as an administrator.
Future<AdminDisableUserResult>	adminDisableUserAsync(AdminDisableUserRequest request)	Disables the specified user as an administrator.
Future<AdminDisableUserResult>	adminDisableUserAsync(AdminDisableUserRequest request, AsyncHandler<AdminDisableUserRequest,AdminDisableUserResult> asyncHandler)	Disables the specified user as an administrator.
Future<AdminEnableUserResult>	adminEnableUserAsync(AdminEnableUserRequest request)	Enables the specified user as an administrator.
Future<AdminEnableUserResult>	adminEnableUserAsync(AdminEnableUserRequest request, AsyncHandler<AdminEnableUserRequest,AdminEnableUserResult> asyncHandler)	Enables the specified user as an administrator.
Future<AdminGetUserResult>	adminGetUserAsync(AdminGetUserRequest request)	Gets the specified user by user name in a user pool as an administrator.
Future<AdminGetUserResult>	adminGetUserAsync(AdminGetUserRequest request, AsyncHandler<AdminGetUserRequest,AdminGetUserResult> asyncHandler)	Gets the specified user by user name in a user pool as an administrator.
Future<AdminResetUserPasswordResult>	adminResetUserPasswordAsync(AdminResetUserPasswordRequest request)	Resets the specified user's password in a user pool as an administrator.
Future<AdminResetUserPasswordResult>	adminResetUserPasswordAsync(AdminResetUserPasswordRequest request, AsyncHandler<AdminResetUserPasswordRequest,AdminResetUserPasswordResult> asyncHandler)	Resets the specified user's password in a user pool as an administrator.
Future<AdminSetUserSettingsResult>	adminSetUserSettingsAsync(AdminSetUserSettingsRequest request)	Sets all the user settings for a specified user name.
Future<AdminSetUserSettingsResult>	adminSetUserSettingsAsync(AdminSetUserSettingsRequest request, AsyncHandler<AdminSetUserSettingsRequest,AdminSetUserSettingsResult> asyncHandler)	Sets all the user settings for a specified user name.
Future<AdminUpdateUserAttributesResult>	adminUpdateUserAttributesAsync(AdminUpdateUserAttributesRequest request)	Updates the specified user's attributes, including developer attributes, as an administrator.
Future<AdminUpdateUserAttributesResult>	adminUpdateUserAttributesAsync(AdminUpdateUserAttributesRequest request, AsyncHandler<AdminUpdateUserAttributesRequest,AdminUpdateUserAttributesResult> asyncHandler)	Updates the specified user's attributes, including developer attributes, as an administrator.
Future<ChangePasswordResult>	changePasswordAsync(ChangePasswordRequest request)	Changes the password for a specified user in a user pool.
Future<ChangePasswordResult>	changePasswordAsync(ChangePasswordRequest request, AsyncHandler<ChangePasswordRequest,ChangePasswordResult> asyncHandler)	Changes the password for a specified user in a user pool.
Future<ConfirmForgotPasswordResult>	confirmForgotPasswordAsync(ConfirmForgotPasswordRequest request)	Allows a user to enter a code provided when they reset their password to update their password.
Future<ConfirmForgotPasswordResult>	confirmForgotPasswordAsync(ConfirmForgotPasswordRequest request, AsyncHandler<ConfirmForgotPasswordRequest,ConfirmForgotPasswordResult> asyncHandler)	Allows a user to enter a code provided when they reset their password to update their password.
Future<ConfirmSignUpResult>	confirmSignUpAsync(ConfirmSignUpRequest request)	Confirms registration of a user and handles the existing alias from a previous user.
Future<ConfirmSignUpResult>	confirmSignUpAsync(ConfirmSignUpRequest request, AsyncHandler<ConfirmSignUpRequest,ConfirmSignUpResult> asyncHandler)	Confirms registration of a user and handles the existing alias from a previous user.
Future<CreateUserPoolResult>	createUserPoolAsync(CreateUserPoolRequest request)	Creates a new Amazon Cognito user pool and sets the password policy for the pool.
Future<CreateUserPoolResult>	createUserPoolAsync(CreateUserPoolRequest request, AsyncHandler<CreateUserPoolRequest,CreateUserPoolResult> asyncHandler)	Creates a new Amazon Cognito user pool and sets the password policy for the pool.
Future<CreateUserPoolClientResult>	createUserPoolClientAsync(CreateUserPoolClientRequest request)	Creates the user pool client.
Future<CreateUserPoolClientResult>	createUserPoolClientAsync(CreateUserPoolClientRequest request, AsyncHandler<CreateUserPoolClientRequest,CreateUserPoolClientResult> asyncHandler)	Creates the user pool client.
Future<DeleteUserResult>	deleteUserAsync(DeleteUserRequest request)	Allows a user to delete one's self.
Future<DeleteUserResult>	deleteUserAsync(DeleteUserRequest request, AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)	Allows a user to delete one's self.
Future<DeleteUserAttributesResult>	deleteUserAttributesAsync(DeleteUserAttributesRequest request)	Deletes the attributes for a user.
Future<DeleteUserAttributesResult>	deleteUserAttributesAsync(DeleteUserAttributesRequest request, AsyncHandler<DeleteUserAttributesRequest,DeleteUserAttributesResult> asyncHandler)	Deletes the attributes for a user.
Future<DeleteUserPoolResult>	deleteUserPoolAsync(DeleteUserPoolRequest request)	Deletes the specified Amazon Cognito user pool.
Future<DeleteUserPoolResult>	deleteUserPoolAsync(DeleteUserPoolRequest request, AsyncHandler<DeleteUserPoolRequest,DeleteUserPoolResult> asyncHandler)	Deletes the specified Amazon Cognito user pool.
Future<DeleteUserPoolClientResult>	deleteUserPoolClientAsync(DeleteUserPoolClientRequest request)	Allows the developer to delete the user pool client.
Future<DeleteUserPoolClientResult>	deleteUserPoolClientAsync(DeleteUserPoolClientRequest request, AsyncHandler<DeleteUserPoolClientRequest,DeleteUserPoolClientResult> asyncHandler)	Allows the developer to delete the user pool client.
Future<DescribeUserPoolResult>	describeUserPoolAsync(DescribeUserPoolRequest request)	Returns the configuration information and metadata of the specified user pool.
Future<DescribeUserPoolResult>	describeUserPoolAsync(DescribeUserPoolRequest request, AsyncHandler<DescribeUserPoolRequest,DescribeUserPoolResult> asyncHandler)	Returns the configuration information and metadata of the specified user pool.
Future<DescribeUserPoolClientResult>	describeUserPoolClientAsync(DescribeUserPoolClientRequest request)	Client method for returning the configuration information and metadata of the specified user pool client.
Future<DescribeUserPoolClientResult>	describeUserPoolClientAsync(DescribeUserPoolClientRequest request, AsyncHandler<DescribeUserPoolClientRequest,DescribeUserPoolClientResult> asyncHandler)	Client method for returning the configuration information and metadata of the specified user pool client.
Future<ForgotPasswordResult>	forgotPasswordAsync(ForgotPasswordRequest request)	Retrieves the password for the specified client ID or username.
Future<ForgotPasswordResult>	forgotPasswordAsync(ForgotPasswordRequest request, AsyncHandler<ForgotPasswordRequest,ForgotPasswordResult> asyncHandler)	Retrieves the password for the specified client ID or username.
ExecutorService	getExecutorService()	Returns the executor service used by this client to execute async requests.
Future<GetUserResult>	getUserAsync(GetUserRequest request)	Gets the user attributes and metadata for a user.
Future<GetUserResult>	getUserAsync(GetUserRequest request, AsyncHandler<GetUserRequest,GetUserResult> asyncHandler)	Gets the user attributes and metadata for a user.
Future<GetUserAttributeVerificationCodeResult>	getUserAttributeVerificationCodeAsync(GetUserAttributeVerificationCodeRequest request)	Gets the user attribute verification code for the specified attribute name.
Future<GetUserAttributeVerificationCodeResult>	getUserAttributeVerificationCodeAsync(GetUserAttributeVerificationCodeRequest request, AsyncHandler<GetUserAttributeVerificationCodeRequest,GetUserAttributeVerificationCodeResult> asyncHandler)	Gets the user attribute verification code for the specified attribute name.
Future<ListUserPoolClientsResult>	listUserPoolClientsAsync(ListUserPoolClientsRequest request)	Lists the clients that have been created for the specified user pool.
Future<ListUserPoolClientsResult>	listUserPoolClientsAsync(ListUserPoolClientsRequest request, AsyncHandler<ListUserPoolClientsRequest,ListUserPoolClientsResult> asyncHandler)	Lists the clients that have been created for the specified user pool.
Future<ListUserPoolsResult>	listUserPoolsAsync(ListUserPoolsRequest request)	Lists the user pools associated with an AWS account.
Future<ListUserPoolsResult>	listUserPoolsAsync(ListUserPoolsRequest request, AsyncHandler<ListUserPoolsRequest,ListUserPoolsResult> asyncHandler)	Lists the user pools associated with an AWS account.
Future<ListUsersResult>	listUsersAsync(ListUsersRequest request)	Lists the users in the Amazon Cognito user pool.
Future<ListUsersResult>	listUsersAsync(ListUsersRequest request, AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler)	Lists the users in the Amazon Cognito user pool.
Future<ResendConfirmationCodeResult>	resendConfirmationCodeAsync(ResendConfirmationCodeRequest request)	Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
Future<ResendConfirmationCodeResult>	resendConfirmationCodeAsync(ResendConfirmationCodeRequest request, AsyncHandler<ResendConfirmationCodeRequest,ResendConfirmationCodeResult> asyncHandler)	Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
Future<SetUserSettingsResult>	setUserSettingsAsync(SetUserSettingsRequest request)	Sets the user settings like multi-factor authentication (MFA).
Future<SetUserSettingsResult>	setUserSettingsAsync(SetUserSettingsRequest request, AsyncHandler<SetUserSettingsRequest,SetUserSettingsResult> asyncHandler)	Sets the user settings like multi-factor authentication (MFA).
void	shutdown()	Shuts down the client, releasing all managed resources.
Future<SignUpResult>	signUpAsync(SignUpRequest request)	Registers the user in the specified user pool and creates a user name, password, and user attributes.
Future<SignUpResult>	signUpAsync(SignUpRequest request, AsyncHandler<SignUpRequest,SignUpResult> asyncHandler)	Registers the user in the specified user pool and creates a user name, password, and user attributes.
Future<UpdateUserAttributesResult>	updateUserAttributesAsync(UpdateUserAttributesRequest request)	Allows a user to update a specific attribute (one at a time).
Future<UpdateUserAttributesResult>	updateUserAttributesAsync(UpdateUserAttributesRequest request, AsyncHandler<UpdateUserAttributesRequest,UpdateUserAttributesResult> asyncHandler)	Allows a user to update a specific attribute (one at a time).
Future<UpdateUserPoolResult>	updateUserPoolAsync(UpdateUserPoolRequest request)	Updates the specified user pool with the specified attributes.
Future<UpdateUserPoolResult>	updateUserPoolAsync(UpdateUserPoolRequest request, AsyncHandler<UpdateUserPoolRequest,UpdateUserPoolResult> asyncHandler)	Updates the specified user pool with the specified attributes.
Future<UpdateUserPoolClientResult>	updateUserPoolClientAsync(UpdateUserPoolClientRequest request)	Allows the developer to update the specified user pool client and password policy.
Future<UpdateUserPoolClientResult>	updateUserPoolClientAsync(UpdateUserPoolClientRequest request, AsyncHandler<UpdateUserPoolClientRequest,UpdateUserPoolClientResult> asyncHandler)	Allows the developer to update the specified user pool client and password policy.
Future<VerifyUserAttributeResult>	verifyUserAttributeAsync(VerifyUserAttributeRequest request)	Verifies the specified user attributes in the user pool.
Future<VerifyUserAttributeResult>	verifyUserAttributeAsync(VerifyUserAttributeRequest request, AsyncHandler<VerifyUserAttributeRequest,VerifyUserAttributeResult> asyncHandler)	Verifies the specified user attributes in the user pool.

Methods inherited from class com.amazonaws.services.cognitoidp.AWSCognitoIdentityProviderClient

addCustomAttributes, adminConfirmSignUp, adminDeleteUser, adminDeleteUserAttributes, adminDisableUser, adminEnableUser, adminGetUser, adminResetUserPassword, adminSetUserSettings, adminUpdateUserAttributes, changePassword, confirmForgotPassword, confirmSignUp, createUserPool, createUserPoolClient, deleteUser, deleteUserAttributes, deleteUserPool, deleteUserPoolClient, describeUserPool, describeUserPoolClient, forgotPassword, getCachedResponseMetadata, getUser, getUserAttributeVerificationCode, listUserPoolClients, listUserPools, listUsers, resendConfirmationCode, setUserSettings, signUp, updateUserAttributes, updateUserPool, updateUserPoolClient, verifyUserAttribute

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeMarshalling, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.cognitoidp.AWSCognitoIdentityProvider

addCustomAttributes, adminConfirmSignUp, adminDeleteUser, adminDeleteUserAttributes, adminDisableUser, adminEnableUser, adminGetUser, adminResetUserPassword, adminSetUserSettings, adminUpdateUserAttributes, changePassword, confirmForgotPassword, confirmSignUp, createUserPool, createUserPoolClient, deleteUser, deleteUserAttributes, deleteUserPool, deleteUserPoolClient, describeUserPool, describeUserPoolClient, forgotPassword, getCachedResponseMetadata, getUser, getUserAttributeVerificationCode, listUserPoolClients, listUserPools, listUsers, resendConfirmationCode, setEndpoint, setRegion, setUserSettings, signUp, updateUserAttributes, updateUserPool, updateUserPoolClient, verifyUserAttribute

Constructor Details

AWSCognitoIdentityProviderAsyncClient

public AWSCognitoIdentityProviderAsyncClient()

Constructs a new asynchronous client to invoke service methods on Amazon Cognito Identity Provider. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
• Instance profile credentials delivered through the Amazon EC2 metadata service

Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

See Also:

• DefaultAWSCredentialsProviderChain
• Executors.newFixedThreadPool(int)

AWSCognitoIdentityProviderAsyncClient

public AWSCognitoIdentityProviderAsyncClient(ClientConfiguration clientConfiguration)

Constructs a new asynchronous client to invoke service methods on Amazon Cognito Identity Provider. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
• Instance profile credentials delivered through the Amazon EC2 metadata service

Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to Amazon Cognito Identity Provider (ex: proxy settings, retry counts, etc).

See Also:

• DefaultAWSCredentialsProviderChain
• Executors.newFixedThreadPool(int)

AWSCognitoIdentityProviderAsyncClient

public AWSCognitoIdentityProviderAsyncClient(AWSCredentials awsCredentials)

Constructs a new asynchronous client to invoke service methods on Amazon Cognito Identity Provider using the specified AWS account credentials.

Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

See Also:

• Executors.newFixedThreadPool(int)

AWSCognitoIdentityProviderAsyncClient

public AWSCognitoIdentityProviderAsyncClient(AWSCredentials awsCredentials,
 ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on Amazon Cognito Identity Provider using the specified AWS account credentials and executor service. Default client settings will be used.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

executorService - The executor service by which all asynchronous requests will be executed.

AWSCognitoIdentityProviderAsyncClient

public AWSCognitoIdentityProviderAsyncClient(AWSCredentials awsCredentials,
 ClientConfiguration clientConfiguration,
 ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on Amazon Cognito Identity Provider using the specified AWS account credentials, executor service, and client configuration options.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

AWSCognitoIdentityProviderAsyncClient

public AWSCognitoIdentityProviderAsyncClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new asynchronous client to invoke service methods on Amazon Cognito Identity Provider using the specified AWS account credentials provider. Default client settings will be used.

Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

See Also:

• Executors.newFixedThreadPool(int)

AWSCognitoIdentityProviderAsyncClient

public AWSCognitoIdentityProviderAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
 ClientConfiguration clientConfiguration)

Constructs a new asynchronous client to invoke service methods on Amazon Cognito Identity Provider using the provided AWS account credentials provider and client configuration options.

Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

See Also:

• DefaultAWSCredentialsProviderChain
• Executors.newFixedThreadPool(int)

AWSCognitoIdentityProviderAsyncClient

public AWSCognitoIdentityProviderAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
 ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on Amazon Cognito Identity Provider using the specified AWS account credentials provider and executor service. Default client settings will be used.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

executorService - The executor service by which all asynchronous requests will be executed.

AWSCognitoIdentityProviderAsyncClient

public AWSCognitoIdentityProviderAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
 ClientConfiguration clientConfiguration,
 ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on Amazon Cognito Identity Provider using the specified AWS account credentials provider, executor service, and client configuration options.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

Method Details

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

addCustomAttributesAsync

public Future<AddCustomAttributesResult> addCustomAttributesAsync(AddCustomAttributesRequest request)

Description copied from interface: AWSCognitoIdentityProviderAsync

Adds additional user attributes to the user pool schema.

Specified by:

addCustomAttributesAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to add custom attributes.

Returns:

A Java Future containing the result of the AddCustomAttributes operation returned by the service.

addCustomAttributesAsync

public Future<AddCustomAttributesResult> addCustomAttributesAsync(AddCustomAttributesRequest request,
 AsyncHandler<AddCustomAttributesRequest,AddCustomAttributesResult> asyncHandler)

Description copied from interface: AWSCognitoIdentityProviderAsync

Adds additional user attributes to the user pool schema.

Specified by:

addCustomAttributesAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to add custom attributes.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the AddCustomAttributes operation returned by the service.

adminConfirmSignUpAsync

public Future<AdminConfirmSignUpResult> adminConfirmSignUpAsync(AdminConfirmSignUpRequest request)

Description copied from interface: AWSCognitoIdentityProviderAsync

Confirms user registration as an admin without using a confirmation code. Works on any user.

Specified by:

adminConfirmSignUpAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to confirm user registration.

Returns:

A Java Future containing the result of the AdminConfirmSignUp operation returned by the service.

adminConfirmSignUpAsync

public Future<AdminConfirmSignUpResult> adminConfirmSignUpAsync(AdminConfirmSignUpRequest request,
 AsyncHandler<AdminConfirmSignUpRequest,AdminConfirmSignUpResult> asyncHandler)

Description copied from interface: AWSCognitoIdentityProviderAsync

Confirms user registration as an admin without using a confirmation code. Works on any user.

Specified by:

adminConfirmSignUpAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to confirm user registration.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the AdminConfirmSignUp operation returned by the service.

adminDeleteUserAsync

public Future<AdminDeleteUserResult> adminDeleteUserAsync(AdminDeleteUserRequest request)

Description copied from interface: AWSCognitoIdentityProviderAsync

Deletes a user as an administrator. Works on any user.

Specified by:

adminDeleteUserAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to delete a user as an administrator.

Returns:

A Java Future containing the result of the AdminDeleteUser operation returned by the service.

adminDeleteUserAsync

public Future<AdminDeleteUserResult> adminDeleteUserAsync(AdminDeleteUserRequest request,
 AsyncHandler<AdminDeleteUserRequest,AdminDeleteUserResult> asyncHandler)

Description copied from interface: AWSCognitoIdentityProviderAsync

Deletes a user as an administrator. Works on any user.

Specified by:

adminDeleteUserAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to delete a user as an administrator.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the AdminDeleteUser operation returned by the service.

adminDeleteUserAttributesAsync

public Future<AdminDeleteUserAttributesResult> adminDeleteUserAttributesAsync(AdminDeleteUserAttributesRequest request)

Description copied from interface: AWSCognitoIdentityProviderAsync

Deletes the user attributes in a user pool as an administrator. Works on any user.

Specified by:

adminDeleteUserAttributesAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to delete user attributes as an administrator.

Returns:

A Java Future containing the result of the AdminDeleteUserAttributes operation returned by the service.

adminDeleteUserAttributesAsync

public Future<AdminDeleteUserAttributesResult> adminDeleteUserAttributesAsync(AdminDeleteUserAttributesRequest request,
 AsyncHandler<AdminDeleteUserAttributesRequest,AdminDeleteUserAttributesResult> asyncHandler)

Description copied from interface: AWSCognitoIdentityProviderAsync

Deletes the user attributes in a user pool as an administrator. Works on any user.

Specified by:

adminDeleteUserAttributesAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to delete user attributes as an administrator.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the AdminDeleteUserAttributes operation returned by the service.

adminDisableUserAsync

public Future<AdminDisableUserResult> adminDisableUserAsync(AdminDisableUserRequest request)

Description copied from interface: AWSCognitoIdentityProviderAsync

Disables the specified user as an administrator. Works on any user.

Specified by:

adminDisableUserAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to disable any user as an administrator.

Returns:

A Java Future containing the result of the AdminDisableUser operation returned by the service.

adminDisableUserAsync

public Future<AdminDisableUserResult> adminDisableUserAsync(AdminDisableUserRequest request,
 AsyncHandler<AdminDisableUserRequest,AdminDisableUserResult> asyncHandler)

Description copied from interface: AWSCognitoIdentityProviderAsync

Disables the specified user as an administrator. Works on any user.

Specified by:

adminDisableUserAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to disable any user as an administrator.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the AdminDisableUser operation returned by the service.

adminEnableUserAsync

public Future<AdminEnableUserResult> adminEnableUserAsync(AdminEnableUserRequest request)

Description copied from interface: AWSCognitoIdentityProviderAsync

Enables the specified user as an administrator. Works on any user.

Specified by:

adminEnableUserAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request that enables the user as an administrator.

Returns:

A Java Future containing the result of the AdminEnableUser operation returned by the service.

adminEnableUserAsync

public Future<AdminEnableUserResult> adminEnableUserAsync(AdminEnableUserRequest request,
 AsyncHandler<AdminEnableUserRequest,AdminEnableUserResult> asyncHandler)

Description copied from interface: AWSCognitoIdentityProviderAsync

Enables the specified user as an administrator. Works on any user.

Specified by:

adminEnableUserAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request that enables the user as an administrator.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the AdminEnableUser operation returned by the service.

adminGetUserAsync

public Future<AdminGetUserResult> adminGetUserAsync(AdminGetUserRequest request)

Description copied from interface: AWSCognitoIdentityProviderAsync

Gets the specified user by user name in a user pool as an administrator. Works on any user.

Specified by:

adminGetUserAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to get the specified user as an administrator.

Returns:

A Java Future containing the result of the AdminGetUser operation returned by the service.

adminGetUserAsync

public Future<AdminGetUserResult> adminGetUserAsync(AdminGetUserRequest request,
 AsyncHandler<AdminGetUserRequest,AdminGetUserResult> asyncHandler)

Description copied from interface: AWSCognitoIdentityProviderAsync

Gets the specified user by user name in a user pool as an administrator. Works on any user.

Specified by:

adminGetUserAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to get the specified user as an administrator.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the AdminGetUser operation returned by the service.

adminResetUserPasswordAsync

public Future<AdminResetUserPasswordResult> adminResetUserPasswordAsync(AdminResetUserPasswordRequest request)

Description copied from interface: AWSCognitoIdentityProviderAsync

Resets the specified user's password in a user pool as an administrator. Works on any user.

Specified by:

adminResetUserPasswordAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to reset a user's password as an administrator.

Returns:

A Java Future containing the result of the AdminResetUserPassword operation returned by the service.

adminResetUserPasswordAsync

public Future<AdminResetUserPasswordResult> adminResetUserPasswordAsync(AdminResetUserPasswordRequest request,
 AsyncHandler<AdminResetUserPasswordRequest,AdminResetUserPasswordResult> asyncHandler)

Description copied from interface: AWSCognitoIdentityProviderAsync

Resets the specified user's password in a user pool as an administrator. Works on any user.

Specified by:

adminResetUserPasswordAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to reset a user's password as an administrator.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the AdminResetUserPassword operation returned by the service.

adminSetUserSettingsAsync

public Future<AdminSetUserSettingsResult> adminSetUserSettingsAsync(AdminSetUserSettingsRequest request)

Description copied from interface: AWSCognitoIdentityProviderAsync

Sets all the user settings for a specified user name. Works on any user.

Specified by:

adminSetUserSettingsAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to set user settings as an administrator.

Returns:

A Java Future containing the result of the AdminSetUserSettings operation returned by the service.

adminSetUserSettingsAsync

public Future<AdminSetUserSettingsResult> adminSetUserSettingsAsync(AdminSetUserSettingsRequest request,
 AsyncHandler<AdminSetUserSettingsRequest,AdminSetUserSettingsResult> asyncHandler)

Description copied from interface: AWSCognitoIdentityProviderAsync

Sets all the user settings for a specified user name. Works on any user.

Specified by:

adminSetUserSettingsAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to set user settings as an administrator.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the AdminSetUserSettings operation returned by the service.

adminUpdateUserAttributesAsync

public Future<AdminUpdateUserAttributesResult> adminUpdateUserAttributesAsync(AdminUpdateUserAttributesRequest request)

Description copied from interface: AWSCognitoIdentityProviderAsync

Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.

Specified by:

adminUpdateUserAttributesAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to update the user's attributes as an administrator.

Returns:

A Java Future containing the result of the AdminUpdateUserAttributes operation returned by the service.

adminUpdateUserAttributesAsync

public Future<AdminUpdateUserAttributesResult> adminUpdateUserAttributesAsync(AdminUpdateUserAttributesRequest request,
 AsyncHandler<AdminUpdateUserAttributesRequest,AdminUpdateUserAttributesResult> asyncHandler)

Description copied from interface: AWSCognitoIdentityProviderAsync

Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.

Specified by:

adminUpdateUserAttributesAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to update the user's attributes as an administrator.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the AdminUpdateUserAttributes operation returned by the service.

changePasswordAsync

public Future<ChangePasswordResult> changePasswordAsync(ChangePasswordRequest request)

Description copied from interface: AWSCognitoIdentityProviderAsync

Changes the password for a specified user in a user pool.

Specified by:

changePasswordAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to change a user password.

Returns:

A Java Future containing the result of the ChangePassword operation returned by the service.

changePasswordAsync

public Future<ChangePasswordResult> changePasswordAsync(ChangePasswordRequest request,
 AsyncHandler<ChangePasswordRequest,ChangePasswordResult> asyncHandler)

Description copied from interface: AWSCognitoIdentityProviderAsync

Changes the password for a specified user in a user pool.

Specified by:

changePasswordAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to change a user password.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ChangePassword operation returned by the service.

confirmForgotPasswordAsync

public Future<ConfirmForgotPasswordResult> confirmForgotPasswordAsync(ConfirmForgotPasswordRequest request)

Description copied from interface: AWSCognitoIdentityProviderAsync

Allows a user to enter a code provided when they reset their password to update their password.

Specified by:

confirmForgotPasswordAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - The request representing the confirmation for a password reset.

Returns:

A Java Future containing the result of the ConfirmForgotPassword operation returned by the service.

confirmForgotPasswordAsync

public Future<ConfirmForgotPasswordResult> confirmForgotPasswordAsync(ConfirmForgotPasswordRequest request,
 AsyncHandler<ConfirmForgotPasswordRequest,ConfirmForgotPasswordResult> asyncHandler)

Description copied from interface: AWSCognitoIdentityProviderAsync

Allows a user to enter a code provided when they reset their password to update their password.

Specified by:

confirmForgotPasswordAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - The request representing the confirmation for a password reset.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ConfirmForgotPassword operation returned by the service.

confirmSignUpAsync

public Future<ConfirmSignUpResult> confirmSignUpAsync(ConfirmSignUpRequest request)

Description copied from interface: AWSCognitoIdentityProviderAsync

Confirms registration of a user and handles the existing alias from a previous user.

Specified by:

confirmSignUpAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to confirm registration of a user.

Returns:

A Java Future containing the result of the ConfirmSignUp operation returned by the service.

confirmSignUpAsync

public Future<ConfirmSignUpResult> confirmSignUpAsync(ConfirmSignUpRequest request,
 AsyncHandler<ConfirmSignUpRequest,ConfirmSignUpResult> asyncHandler)

Description copied from interface: AWSCognitoIdentityProviderAsync

Confirms registration of a user and handles the existing alias from a previous user.

Specified by:

confirmSignUpAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to confirm registration of a user.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ConfirmSignUp operation returned by the service.

createUserPoolAsync

public Future<CreateUserPoolResult> createUserPoolAsync(CreateUserPoolRequest request)

Description copied from interface: AWSCognitoIdentityProviderAsync

Creates a new Amazon Cognito user pool and sets the password policy for the pool.

Specified by:

createUserPoolAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to create a user pool.

Returns:

A Java Future containing the result of the CreateUserPool operation returned by the service.

createUserPoolAsync

public Future<CreateUserPoolResult> createUserPoolAsync(CreateUserPoolRequest request,
 AsyncHandler<CreateUserPoolRequest,CreateUserPoolResult> asyncHandler)

Description copied from interface: AWSCognitoIdentityProviderAsync

Creates a new Amazon Cognito user pool and sets the password policy for the pool.

Specified by:

createUserPoolAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to create a user pool.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CreateUserPool operation returned by the service.

createUserPoolClientAsync

public Future<CreateUserPoolClientResult> createUserPoolClientAsync(CreateUserPoolClientRequest request)

Description copied from interface: AWSCognitoIdentityProviderAsync

Creates the user pool client.

Specified by:

createUserPoolClientAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to create a user pool client.

Returns:

A Java Future containing the result of the CreateUserPoolClient operation returned by the service.

createUserPoolClientAsync

public Future<CreateUserPoolClientResult> createUserPoolClientAsync(CreateUserPoolClientRequest request,
 AsyncHandler<CreateUserPoolClientRequest,CreateUserPoolClientResult> asyncHandler)

Description copied from interface: AWSCognitoIdentityProviderAsync

Creates the user pool client.

Specified by:

createUserPoolClientAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to create a user pool client.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CreateUserPoolClient operation returned by the service.

deleteUserAsync

public Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest request)

Description copied from interface: AWSCognitoIdentityProviderAsync

Allows a user to delete one's self.

Specified by:

deleteUserAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to delete a user.

Returns:

A Java Future containing the result of the DeleteUser operation returned by the service.

deleteUserAsync

public Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest request,
 AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)

Description copied from interface: AWSCognitoIdentityProviderAsync

Allows a user to delete one's self.

Specified by:

deleteUserAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to delete a user.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteUser operation returned by the service.

deleteUserAttributesAsync

public Future<DeleteUserAttributesResult> deleteUserAttributesAsync(DeleteUserAttributesRequest request)

Description copied from interface: AWSCognitoIdentityProviderAsync

Deletes the attributes for a user.

Specified by:

deleteUserAttributesAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to delete user attributes.

Returns:

A Java Future containing the result of the DeleteUserAttributes operation returned by the service.

deleteUserAttributesAsync

public Future<DeleteUserAttributesResult> deleteUserAttributesAsync(DeleteUserAttributesRequest request,
 AsyncHandler<DeleteUserAttributesRequest,DeleteUserAttributesResult> asyncHandler)

Description copied from interface: AWSCognitoIdentityProviderAsync

Deletes the attributes for a user.

Specified by:

deleteUserAttributesAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to delete user attributes.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteUserAttributes operation returned by the service.

deleteUserPoolAsync

public Future<DeleteUserPoolResult> deleteUserPoolAsync(DeleteUserPoolRequest request)

Description copied from interface: AWSCognitoIdentityProviderAsync

Deletes the specified Amazon Cognito user pool.

Specified by:

deleteUserPoolAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to delete a user pool.

Returns:

A Java Future containing the result of the DeleteUserPool operation returned by the service.

deleteUserPoolAsync

public Future<DeleteUserPoolResult> deleteUserPoolAsync(DeleteUserPoolRequest request,
 AsyncHandler<DeleteUserPoolRequest,DeleteUserPoolResult> asyncHandler)

Description copied from interface: AWSCognitoIdentityProviderAsync

Deletes the specified Amazon Cognito user pool.

Specified by:

deleteUserPoolAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to delete a user pool.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteUserPool operation returned by the service.

deleteUserPoolClientAsync

public Future<DeleteUserPoolClientResult> deleteUserPoolClientAsync(DeleteUserPoolClientRequest request)

Description copied from interface: AWSCognitoIdentityProviderAsync

Allows the developer to delete the user pool client.

Specified by:

deleteUserPoolClientAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to delete a user pool client.

Returns:

A Java Future containing the result of the DeleteUserPoolClient operation returned by the service.

deleteUserPoolClientAsync

public Future<DeleteUserPoolClientResult> deleteUserPoolClientAsync(DeleteUserPoolClientRequest request,
 AsyncHandler<DeleteUserPoolClientRequest,DeleteUserPoolClientResult> asyncHandler)

Description copied from interface: AWSCognitoIdentityProviderAsync

Allows the developer to delete the user pool client.

Specified by:

deleteUserPoolClientAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to delete a user pool client.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteUserPoolClient operation returned by the service.

describeUserPoolAsync

public Future<DescribeUserPoolResult> describeUserPoolAsync(DescribeUserPoolRequest request)

Description copied from interface: AWSCognitoIdentityProviderAsync

Returns the configuration information and metadata of the specified user pool.

Specified by:

describeUserPoolAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to describe the user pool.

Returns:

A Java Future containing the result of the DescribeUserPool operation returned by the service.

describeUserPoolAsync

public Future<DescribeUserPoolResult> describeUserPoolAsync(DescribeUserPoolRequest request,
 AsyncHandler<DescribeUserPoolRequest,DescribeUserPoolResult> asyncHandler)

Description copied from interface: AWSCognitoIdentityProviderAsync

Returns the configuration information and metadata of the specified user pool.

Specified by:

describeUserPoolAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to describe the user pool.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DescribeUserPool operation returned by the service.

describeUserPoolClientAsync

public Future<DescribeUserPoolClientResult> describeUserPoolClientAsync(DescribeUserPoolClientRequest request)

Description copied from interface: AWSCognitoIdentityProviderAsync

Client method for returning the configuration information and metadata of the specified user pool client.

Specified by:

describeUserPoolClientAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to describe a user pool client.

Returns:

A Java Future containing the result of the DescribeUserPoolClient operation returned by the service.

describeUserPoolClientAsync

public Future<DescribeUserPoolClientResult> describeUserPoolClientAsync(DescribeUserPoolClientRequest request,
 AsyncHandler<DescribeUserPoolClientRequest,DescribeUserPoolClientResult> asyncHandler)

Description copied from interface: AWSCognitoIdentityProviderAsync

Client method for returning the configuration information and metadata of the specified user pool client.

Specified by:

describeUserPoolClientAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to describe a user pool client.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DescribeUserPoolClient operation returned by the service.

forgotPasswordAsync

public Future<ForgotPasswordResult> forgotPasswordAsync(ForgotPasswordRequest request)

Description copied from interface: AWSCognitoIdentityProviderAsync

Retrieves the password for the specified client ID or username.

Specified by:

forgotPasswordAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to reset a user's password.

Returns:

A Java Future containing the result of the ForgotPassword operation returned by the service.

forgotPasswordAsync

public Future<ForgotPasswordResult> forgotPasswordAsync(ForgotPasswordRequest request,
 AsyncHandler<ForgotPasswordRequest,ForgotPasswordResult> asyncHandler)

Description copied from interface: AWSCognitoIdentityProviderAsync

Retrieves the password for the specified client ID or username.

Specified by:

forgotPasswordAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to reset a user's password.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ForgotPassword operation returned by the service.

getUserAsync

public Future<GetUserResult> getUserAsync(GetUserRequest request)

Description copied from interface: AWSCognitoIdentityProviderAsync

Gets the user attributes and metadata for a user.

Specified by:

getUserAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to get information about the user.

Returns:

A Java Future containing the result of the GetUser operation returned by the service.

getUserAsync

public Future<GetUserResult> getUserAsync(GetUserRequest request,
 AsyncHandler<GetUserRequest,GetUserResult> asyncHandler)

Description copied from interface: AWSCognitoIdentityProviderAsync

Gets the user attributes and metadata for a user.

Specified by:

getUserAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to get information about the user.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetUser operation returned by the service.

getUserAttributeVerificationCodeAsync

public Future<GetUserAttributeVerificationCodeResult> getUserAttributeVerificationCodeAsync(GetUserAttributeVerificationCodeRequest request)

Description copied from interface: AWSCognitoIdentityProviderAsync

Gets the user attribute verification code for the specified attribute name.

Specified by:

getUserAttributeVerificationCodeAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to get user attribute verification.

Returns:

A Java Future containing the result of the GetUserAttributeVerificationCode operation returned by the service.

getUserAttributeVerificationCodeAsync

public Future<GetUserAttributeVerificationCodeResult> getUserAttributeVerificationCodeAsync(GetUserAttributeVerificationCodeRequest request,
 AsyncHandler<GetUserAttributeVerificationCodeRequest,GetUserAttributeVerificationCodeResult> asyncHandler)

Description copied from interface: AWSCognitoIdentityProviderAsync

Gets the user attribute verification code for the specified attribute name.

Specified by:

getUserAttributeVerificationCodeAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to get user attribute verification.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetUserAttributeVerificationCode operation returned by the service.

listUserPoolClientsAsync

public Future<ListUserPoolClientsResult> listUserPoolClientsAsync(ListUserPoolClientsRequest request)

Description copied from interface: AWSCognitoIdentityProviderAsync

Lists the clients that have been created for the specified user pool.

Specified by:

listUserPoolClientsAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to list the user pool clients.

Returns:

A Java Future containing the result of the ListUserPoolClients operation returned by the service.

listUserPoolClientsAsync

public Future<ListUserPoolClientsResult> listUserPoolClientsAsync(ListUserPoolClientsRequest request,
 AsyncHandler<ListUserPoolClientsRequest,ListUserPoolClientsResult> asyncHandler)

Description copied from interface: AWSCognitoIdentityProviderAsync

Lists the clients that have been created for the specified user pool.

Specified by:

listUserPoolClientsAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to list the user pool clients.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListUserPoolClients operation returned by the service.

listUserPoolsAsync

public Future<ListUserPoolsResult> listUserPoolsAsync(ListUserPoolsRequest request)

Description copied from interface: AWSCognitoIdentityProviderAsync

Lists the user pools associated with an AWS account.

Specified by:

listUserPoolsAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to list user pools.

Returns:

A Java Future containing the result of the ListUserPools operation returned by the service.

listUserPoolsAsync

public Future<ListUserPoolsResult> listUserPoolsAsync(ListUserPoolsRequest request,
 AsyncHandler<ListUserPoolsRequest,ListUserPoolsResult> asyncHandler)

Description copied from interface: AWSCognitoIdentityProviderAsync

Lists the user pools associated with an AWS account.

Specified by:

listUserPoolsAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to list user pools.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListUserPools operation returned by the service.

listUsersAsync

public Future<ListUsersResult> listUsersAsync(ListUsersRequest request)

Description copied from interface: AWSCognitoIdentityProviderAsync

Lists the users in the Amazon Cognito user pool.

Specified by:

listUsersAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to list users.

Returns:

A Java Future containing the result of the ListUsers operation returned by the service.

listUsersAsync

public Future<ListUsersResult> listUsersAsync(ListUsersRequest request,
 AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler)

Description copied from interface: AWSCognitoIdentityProviderAsync

Lists the users in the Amazon Cognito user pool.

Specified by:

listUsersAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to list users.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListUsers operation returned by the service.

resendConfirmationCodeAsync

public Future<ResendConfirmationCodeResult> resendConfirmationCodeAsync(ResendConfirmationCodeRequest request)

Description copied from interface: AWSCognitoIdentityProviderAsync

Resends the confirmation (for confirmation of registration) to a specific user in the user pool.

Specified by:

resendConfirmationCodeAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to resend the confirmation code.

Returns:

A Java Future containing the result of the ResendConfirmationCode operation returned by the service.

resendConfirmationCodeAsync

public Future<ResendConfirmationCodeResult> resendConfirmationCodeAsync(ResendConfirmationCodeRequest request,
 AsyncHandler<ResendConfirmationCodeRequest,ResendConfirmationCodeResult> asyncHandler)

Description copied from interface: AWSCognitoIdentityProviderAsync

Resends the confirmation (for confirmation of registration) to a specific user in the user pool.

Specified by:

resendConfirmationCodeAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to resend the confirmation code.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ResendConfirmationCode operation returned by the service.

setUserSettingsAsync

public Future<SetUserSettingsResult> setUserSettingsAsync(SetUserSettingsRequest request)

Description copied from interface: AWSCognitoIdentityProviderAsync

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.

Specified by:

setUserSettingsAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to set user settings.

Returns:

A Java Future containing the result of the SetUserSettings operation returned by the service.

setUserSettingsAsync

public Future<SetUserSettingsResult> setUserSettingsAsync(SetUserSettingsRequest request,
 AsyncHandler<SetUserSettingsRequest,SetUserSettingsResult> asyncHandler)

Description copied from interface: AWSCognitoIdentityProviderAsync

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.

Specified by:

setUserSettingsAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to set user settings.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the SetUserSettings operation returned by the service.

signUpAsync

public Future<SignUpResult> signUpAsync(SignUpRequest request)

Description copied from interface: AWSCognitoIdentityProviderAsync

Registers the user in the specified user pool and creates a user name, password, and user attributes.

Specified by:

signUpAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to register a user.

Returns:

A Java Future containing the result of the SignUp operation returned by the service.

signUpAsync

public Future<SignUpResult> signUpAsync(SignUpRequest request,
 AsyncHandler<SignUpRequest,SignUpResult> asyncHandler)

Description copied from interface: AWSCognitoIdentityProviderAsync

Registers the user in the specified user pool and creates a user name, password, and user attributes.

Specified by:

signUpAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to register a user.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the SignUp operation returned by the service.

updateUserAttributesAsync

public Future<UpdateUserAttributesResult> updateUserAttributesAsync(UpdateUserAttributesRequest request)

Description copied from interface: AWSCognitoIdentityProviderAsync

Allows a user to update a specific attribute (one at a time).

Specified by:

updateUserAttributesAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to update user attributes.

Returns:

A Java Future containing the result of the UpdateUserAttributes operation returned by the service.

updateUserAttributesAsync

public Future<UpdateUserAttributesResult> updateUserAttributesAsync(UpdateUserAttributesRequest request,
 AsyncHandler<UpdateUserAttributesRequest,UpdateUserAttributesResult> asyncHandler)

Description copied from interface: AWSCognitoIdentityProviderAsync

Allows a user to update a specific attribute (one at a time).

Specified by:

updateUserAttributesAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to update user attributes.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the UpdateUserAttributes operation returned by the service.

updateUserPoolAsync

public Future<UpdateUserPoolResult> updateUserPoolAsync(UpdateUserPoolRequest request)

Description copied from interface: AWSCognitoIdentityProviderAsync

Updates the specified user pool with the specified attributes.

Specified by:

updateUserPoolAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to update the user pool.

Returns:

A Java Future containing the result of the UpdateUserPool operation returned by the service.

updateUserPoolAsync

public Future<UpdateUserPoolResult> updateUserPoolAsync(UpdateUserPoolRequest request,
 AsyncHandler<UpdateUserPoolRequest,UpdateUserPoolResult> asyncHandler)

Description copied from interface: AWSCognitoIdentityProviderAsync

Updates the specified user pool with the specified attributes.

Specified by:

updateUserPoolAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to update the user pool.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the UpdateUserPool operation returned by the service.

updateUserPoolClientAsync

public Future<UpdateUserPoolClientResult> updateUserPoolClientAsync(UpdateUserPoolClientRequest request)

Description copied from interface: AWSCognitoIdentityProviderAsync

Allows the developer to update the specified user pool client and password policy.

Specified by:

updateUserPoolClientAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to update the user pool client.

Returns:

A Java Future containing the result of the UpdateUserPoolClient operation returned by the service.

updateUserPoolClientAsync

public Future<UpdateUserPoolClientResult> updateUserPoolClientAsync(UpdateUserPoolClientRequest request,
 AsyncHandler<UpdateUserPoolClientRequest,UpdateUserPoolClientResult> asyncHandler)

Description copied from interface: AWSCognitoIdentityProviderAsync

Allows the developer to update the specified user pool client and password policy.

Specified by:

updateUserPoolClientAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to update the user pool client.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the UpdateUserPoolClient operation returned by the service.

verifyUserAttributeAsync

public Future<VerifyUserAttributeResult> verifyUserAttributeAsync(VerifyUserAttributeRequest request)

Description copied from interface: AWSCognitoIdentityProviderAsync

Verifies the specified user attributes in the user pool.

Specified by:

verifyUserAttributeAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to verify user attributes.

Returns:

A Java Future containing the result of the VerifyUserAttribute operation returned by the service.

verifyUserAttributeAsync

public Future<VerifyUserAttributeResult> verifyUserAttributeAsync(VerifyUserAttributeRequest request,
 AsyncHandler<VerifyUserAttributeRequest,VerifyUserAttributeResult> asyncHandler)

Description copied from interface: AWSCognitoIdentityProviderAsync

Verifies the specified user attributes in the user pool.

Specified by:

verifyUserAttributeAsync in interface AWSCognitoIdentityProviderAsync

Parameters:

request - Represents the request to verify user attributes.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the VerifyUserAttribute operation returned by the service.

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AWSCognitoIdentityProvider

Overrides:

shutdown in class AmazonWebServiceClient