@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSCognitoIdentityProviderAsyncClient extends AWSCognitoIdentityProviderClient implements AWSCognitoIdentityProviderAsync
AsyncHandler can be used to
receive notification when an asynchronous operation completes.
Using the Amazon Cognito User Pools API, you can create a user pool to manage directories and users. You can authenticate a user to obtain tokens related to user identity and access policies.
This API reference provides information about user pools in Amazon Cognito User Pools.
For more information, see the Amazon Cognito Documentation.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXaddCustomAttributes, adminAddUserToGroup, adminConfirmSignUp, adminCreateUser, adminDeleteUser, adminDeleteUserAttributes, adminDisableProviderForUser, adminDisableUser, adminEnableUser, adminForgetDevice, adminGetDevice, adminGetUser, adminInitiateAuth, adminLinkProviderForUser, adminListDevices, adminListGroupsForUser, adminRemoveUserFromGroup, adminResetUserPassword, adminRespondToAuthChallenge, adminSetUserSettings, adminUpdateDeviceStatus, adminUpdateUserAttributes, adminUserGlobalSignOut, builder, changePassword, confirmDevice, confirmForgotPassword, confirmSignUp, createGroup, createIdentityProvider, createResourceServer, createUserImportJob, createUserPool, createUserPoolClient, createUserPoolDomain, deleteGroup, deleteIdentityProvider, deleteResourceServer, deleteUser, deleteUserAttributes, deleteUserPool, deleteUserPoolClient, deleteUserPoolDomain, describeIdentityProvider, describeResourceServer, describeUserImportJob, describeUserPool, describeUserPoolClient, describeUserPoolDomain, forgetDevice, forgotPassword, getCachedResponseMetadata, getCSVHeader, getDevice, getGroup, getIdentityProviderByIdentifier, getUICustomization, getUser, getUserAttributeVerificationCode, globalSignOut, initiateAuth, listDevices, listGroups, listIdentityProviders, listResourceServers, listUserImportJobs, listUserPoolClients, listUserPools, listUsers, listUsersInGroup, resendConfirmationCode, respondToAuthChallenge, setUICustomization, setUserSettings, signUp, startUserImportJob, stopUserImportJob, updateDeviceStatus, updateGroup, updateIdentityProvider, updateResourceServer, updateUserAttributes, updateUserPool, updateUserPoolClient, verifyUserAttributeaddRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitaddCustomAttributes, adminAddUserToGroup, adminConfirmSignUp, adminCreateUser, adminDeleteUser, adminDeleteUserAttributes, adminDisableProviderForUser, adminDisableUser, adminEnableUser, adminForgetDevice, adminGetDevice, adminGetUser, adminInitiateAuth, adminLinkProviderForUser, adminListDevices, adminListGroupsForUser, adminRemoveUserFromGroup, adminResetUserPassword, adminRespondToAuthChallenge, adminSetUserSettings, adminUpdateDeviceStatus, adminUpdateUserAttributes, adminUserGlobalSignOut, changePassword, confirmDevice, confirmForgotPassword, confirmSignUp, createGroup, createIdentityProvider, createResourceServer, createUserImportJob, createUserPool, createUserPoolClient, createUserPoolDomain, deleteGroup, deleteIdentityProvider, deleteResourceServer, deleteUser, deleteUserAttributes, deleteUserPool, deleteUserPoolClient, deleteUserPoolDomain, describeIdentityProvider, describeResourceServer, describeUserImportJob, describeUserPool, describeUserPoolClient, describeUserPoolDomain, forgetDevice, forgotPassword, getCachedResponseMetadata, getCSVHeader, getDevice, getGroup, getIdentityProviderByIdentifier, getUICustomization, getUser, getUserAttributeVerificationCode, globalSignOut, initiateAuth, listDevices, listGroups, listIdentityProviders, listResourceServers, listUserImportJobs, listUserPoolClients, listUserPools, listUsers, listUsersInGroup, resendConfirmationCode, respondToAuthChallenge, setEndpoint, setRegion, setUICustomization, setUserSettings, signUp, startUserImportJob, stopUserImportJob, updateDeviceStatus, updateGroup, updateIdentityProvider, updateResourceServer, updateUserAttributes, updateUserPool, updateUserPoolClient, verifyUserAttribute@Deprecated public AWSCognitoIdentityProviderAsyncClient()
AWSCognitoIdentityProviderAsyncClientBuilder.defaultClient()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).
@Deprecated public AWSCognitoIdentityProviderAsyncClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
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().
clientConfiguration - The client configuration options controlling how this client connects to Amazon Cognito Identity Provider
(ex: proxy settings, retry counts, etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)@Deprecated public AWSCognitoIdentityProviderAsyncClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)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).
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.Executors.newFixedThreadPool(int)@Deprecated public AWSCognitoIdentityProviderAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)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.@Deprecated public AWSCognitoIdentityProviderAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)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.@Deprecated public AWSCognitoIdentityProviderAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)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).
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.Executors.newFixedThreadPool(int)@Deprecated public AWSCognitoIdentityProviderAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
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().
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).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)@Deprecated public AWSCognitoIdentityProviderAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)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.@Deprecated public AWSCognitoIdentityProviderAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)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.public static AWSCognitoIdentityProviderAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<AddCustomAttributesResult> addCustomAttributesAsync(AddCustomAttributesRequest request)
AWSCognitoIdentityProviderAsyncAdds additional user attributes to the user pool schema.
addCustomAttributesAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to add custom attributes.public Future<AddCustomAttributesResult> addCustomAttributesAsync(AddCustomAttributesRequest request, AsyncHandler<AddCustomAttributesRequest,AddCustomAttributesResult> asyncHandler)
AWSCognitoIdentityProviderAsyncAdds additional user attributes to the user pool schema.
addCustomAttributesAsync in interface AWSCognitoIdentityProviderAsyncrequest - 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.public Future<AdminAddUserToGroupResult> adminAddUserToGroupAsync(AdminAddUserToGroupRequest request)
AWSCognitoIdentityProviderAsyncAdds the specified user to the specified group.
Requires developer credentials.
adminAddUserToGroupAsync in interface AWSCognitoIdentityProviderAsyncpublic Future<AdminAddUserToGroupResult> adminAddUserToGroupAsync(AdminAddUserToGroupRequest request, AsyncHandler<AdminAddUserToGroupRequest,AdminAddUserToGroupResult> asyncHandler)
AWSCognitoIdentityProviderAsyncAdds the specified user to the specified group.
Requires developer credentials.
adminAddUserToGroupAsync in interface AWSCognitoIdentityProviderAsyncasyncHandler - 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.public Future<AdminConfirmSignUpResult> adminConfirmSignUpAsync(AdminConfirmSignUpRequest request)
AWSCognitoIdentityProviderAsyncConfirms user registration as an admin without using a confirmation code. Works on any user.
Requires developer credentials.
adminConfirmSignUpAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to confirm user registration.public Future<AdminConfirmSignUpResult> adminConfirmSignUpAsync(AdminConfirmSignUpRequest request, AsyncHandler<AdminConfirmSignUpRequest,AdminConfirmSignUpResult> asyncHandler)
AWSCognitoIdentityProviderAsyncConfirms user registration as an admin without using a confirmation code. Works on any user.
Requires developer credentials.
adminConfirmSignUpAsync in interface AWSCognitoIdentityProviderAsyncrequest - 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.public Future<AdminCreateUserResult> adminCreateUserAsync(AdminCreateUserRequest request)
AWSCognitoIdentityProviderAsyncCreates a new user in the specified user pool and sends a welcome message via email or phone (SMS). This message is based on a template that you configured in your call to CreateUserPool or UpdateUserPool. This template includes your custom sign-up instructions and placeholders for user name and temporary password.
Requires developer credentials.
adminCreateUserAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to create a user in the specified user pool.public Future<AdminCreateUserResult> adminCreateUserAsync(AdminCreateUserRequest request, AsyncHandler<AdminCreateUserRequest,AdminCreateUserResult> asyncHandler)
AWSCognitoIdentityProviderAsyncCreates a new user in the specified user pool and sends a welcome message via email or phone (SMS). This message is based on a template that you configured in your call to CreateUserPool or UpdateUserPool. This template includes your custom sign-up instructions and placeholders for user name and temporary password.
Requires developer credentials.
adminCreateUserAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to create a user in the specified user pool.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AdminDeleteUserResult> adminDeleteUserAsync(AdminDeleteUserRequest request)
AWSCognitoIdentityProviderAsyncDeletes a user as an administrator. Works on any user.
Requires developer credentials.
adminDeleteUserAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to delete a user as an administrator.public Future<AdminDeleteUserResult> adminDeleteUserAsync(AdminDeleteUserRequest request, AsyncHandler<AdminDeleteUserRequest,AdminDeleteUserResult> asyncHandler)
AWSCognitoIdentityProviderAsyncDeletes a user as an administrator. Works on any user.
Requires developer credentials.
adminDeleteUserAsync in interface AWSCognitoIdentityProviderAsyncrequest - 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.public Future<AdminDeleteUserAttributesResult> adminDeleteUserAttributesAsync(AdminDeleteUserAttributesRequest request)
AWSCognitoIdentityProviderAsyncDeletes the user attributes in a user pool as an administrator. Works on any user.
Requires developer credentials.
adminDeleteUserAttributesAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to delete user attributes as an administrator.public Future<AdminDeleteUserAttributesResult> adminDeleteUserAttributesAsync(AdminDeleteUserAttributesRequest request, AsyncHandler<AdminDeleteUserAttributesRequest,AdminDeleteUserAttributesResult> asyncHandler)
AWSCognitoIdentityProviderAsyncDeletes the user attributes in a user pool as an administrator. Works on any user.
Requires developer credentials.
adminDeleteUserAttributesAsync in interface AWSCognitoIdentityProviderAsyncrequest - 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.public Future<AdminDisableProviderForUserResult> adminDisableProviderForUserAsync(AdminDisableProviderForUserRequest request)
AWSCognitoIdentityProviderAsync
Disables the user from signing in with the specified external (SAML or social) identity provider. If the user to
disable is a Cognito User Pools native username + password user, they are not permitted to use their password to
sign-in. If the user to disable is a linked external IdP user, any link between that user and an existing user is
removed. The next time the external user (no longer attached to the previously linked
DestinationUser) signs in, they must create a new user account. See AdminLinkProviderForUser.
This action is enabled only for admin access and requires developer credentials.
The ProviderName must match the value specified when creating an IdP for the pool.
To disable a native username + password user, the ProviderName value must be Cognito
and the ProviderAttributeName must be Cognito_Subject, with the
ProviderAttributeValue being the name that is used in the user pool for the user.
The ProviderAttributeName must always be Cognito_Subject for social identity providers.
The ProviderAttributeValue must always be the exact subject that was used when the user was
originally linked as a source user.
For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign-in,
the ProviderAttributeName and ProviderAttributeValue must be the same values that were
used for the SourceUser when the identities were originally linked in the AdminLinkProviderForUser call. (If the linking was done with
ProviderAttributeName set to Cognito_Subject, the same applies here). However, if the
user has already signed in, the ProviderAttributeName must be Cognito_Subject and
ProviderAttributeValue must be the subject of the SAML assertion.
adminDisableProviderForUserAsync in interface AWSCognitoIdentityProviderAsyncpublic Future<AdminDisableProviderForUserResult> adminDisableProviderForUserAsync(AdminDisableProviderForUserRequest request, AsyncHandler<AdminDisableProviderForUserRequest,AdminDisableProviderForUserResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Disables the user from signing in with the specified external (SAML or social) identity provider. If the user to
disable is a Cognito User Pools native username + password user, they are not permitted to use their password to
sign-in. If the user to disable is a linked external IdP user, any link between that user and an existing user is
removed. The next time the external user (no longer attached to the previously linked
DestinationUser) signs in, they must create a new user account. See AdminLinkProviderForUser.
This action is enabled only for admin access and requires developer credentials.
The ProviderName must match the value specified when creating an IdP for the pool.
To disable a native username + password user, the ProviderName value must be Cognito
and the ProviderAttributeName must be Cognito_Subject, with the
ProviderAttributeValue being the name that is used in the user pool for the user.
The ProviderAttributeName must always be Cognito_Subject for social identity providers.
The ProviderAttributeValue must always be the exact subject that was used when the user was
originally linked as a source user.
For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign-in,
the ProviderAttributeName and ProviderAttributeValue must be the same values that were
used for the SourceUser when the identities were originally linked in the AdminLinkProviderForUser call. (If the linking was done with
ProviderAttributeName set to Cognito_Subject, the same applies here). However, if the
user has already signed in, the ProviderAttributeName must be Cognito_Subject and
ProviderAttributeValue must be the subject of the SAML assertion.
adminDisableProviderForUserAsync in interface AWSCognitoIdentityProviderAsyncasyncHandler - 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.public Future<AdminDisableUserResult> adminDisableUserAsync(AdminDisableUserRequest request)
AWSCognitoIdentityProviderAsyncDisables the specified user as an administrator. Works on any user.
Requires developer credentials.
adminDisableUserAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to disable any user as an administrator.public Future<AdminDisableUserResult> adminDisableUserAsync(AdminDisableUserRequest request, AsyncHandler<AdminDisableUserRequest,AdminDisableUserResult> asyncHandler)
AWSCognitoIdentityProviderAsyncDisables the specified user as an administrator. Works on any user.
Requires developer credentials.
adminDisableUserAsync in interface AWSCognitoIdentityProviderAsyncrequest - 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.public Future<AdminEnableUserResult> adminEnableUserAsync(AdminEnableUserRequest request)
AWSCognitoIdentityProviderAsyncEnables the specified user as an administrator. Works on any user.
Requires developer credentials.
adminEnableUserAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request that enables the user as an administrator.public Future<AdminEnableUserResult> adminEnableUserAsync(AdminEnableUserRequest request, AsyncHandler<AdminEnableUserRequest,AdminEnableUserResult> asyncHandler)
AWSCognitoIdentityProviderAsyncEnables the specified user as an administrator. Works on any user.
Requires developer credentials.
adminEnableUserAsync in interface AWSCognitoIdentityProviderAsyncrequest - 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.public Future<AdminForgetDeviceResult> adminForgetDeviceAsync(AdminForgetDeviceRequest request)
AWSCognitoIdentityProviderAsyncForgets the device, as an administrator.
Requires developer credentials.
adminForgetDeviceAsync in interface AWSCognitoIdentityProviderAsyncrequest - Sends the forgot device request, as an administrator.public Future<AdminForgetDeviceResult> adminForgetDeviceAsync(AdminForgetDeviceRequest request, AsyncHandler<AdminForgetDeviceRequest,AdminForgetDeviceResult> asyncHandler)
AWSCognitoIdentityProviderAsyncForgets the device, as an administrator.
Requires developer credentials.
adminForgetDeviceAsync in interface AWSCognitoIdentityProviderAsyncrequest - Sends the forgot device request, as an administrator.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AdminGetDeviceResult> adminGetDeviceAsync(AdminGetDeviceRequest request)
AWSCognitoIdentityProviderAsyncGets the device, as an administrator.
Requires developer credentials.
adminGetDeviceAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to get the device, as an administrator.public Future<AdminGetDeviceResult> adminGetDeviceAsync(AdminGetDeviceRequest request, AsyncHandler<AdminGetDeviceRequest,AdminGetDeviceResult> asyncHandler)
AWSCognitoIdentityProviderAsyncGets the device, as an administrator.
Requires developer credentials.
adminGetDeviceAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to get the device, as an administrator.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AdminGetUserResult> adminGetUserAsync(AdminGetUserRequest request)
AWSCognitoIdentityProviderAsyncGets the specified user by user name in a user pool as an administrator. Works on any user.
Requires developer credentials.
adminGetUserAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to get the specified user as an administrator.public Future<AdminGetUserResult> adminGetUserAsync(AdminGetUserRequest request, AsyncHandler<AdminGetUserRequest,AdminGetUserResult> asyncHandler)
AWSCognitoIdentityProviderAsyncGets the specified user by user name in a user pool as an administrator. Works on any user.
Requires developer credentials.
adminGetUserAsync in interface AWSCognitoIdentityProviderAsyncrequest - 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.public Future<AdminInitiateAuthResult> adminInitiateAuthAsync(AdminInitiateAuthRequest request)
AWSCognitoIdentityProviderAsyncInitiates the authentication flow, as an administrator.
Requires developer credentials.
adminInitiateAuthAsync in interface AWSCognitoIdentityProviderAsyncrequest - Initiates the authorization request, as an administrator.public Future<AdminInitiateAuthResult> adminInitiateAuthAsync(AdminInitiateAuthRequest request, AsyncHandler<AdminInitiateAuthRequest,AdminInitiateAuthResult> asyncHandler)
AWSCognitoIdentityProviderAsyncInitiates the authentication flow, as an administrator.
Requires developer credentials.
adminInitiateAuthAsync in interface AWSCognitoIdentityProviderAsyncrequest - Initiates the authorization request, as an administrator.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AdminLinkProviderForUserResult> adminLinkProviderForUserAsync(AdminLinkProviderForUserRequest request)
AWSCognitoIdentityProviderAsync
Links an existing user account in a user pool (DestinationUser) to an identity from an external
identity provider (SourceUser) based on a specified attribute name and value from the external
identity provider. This allows you to create a link from the existing user account to an external federated user
identity that has not yet been used to sign in, so that the federated user identity can be used to sign in as the
existing user account.
For example, if there is an existing user with a username and password, this API links that user to a federated user identity, so that when the federated user identity is used, the user signs in as the existing user account.
Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external identity providers and provider attributes that have been trusted by the application owner.
See also AdminDisableProviderForUser.
This action is enabled only for admin access and requires developer credentials.
adminLinkProviderForUserAsync in interface AWSCognitoIdentityProviderAsyncpublic Future<AdminLinkProviderForUserResult> adminLinkProviderForUserAsync(AdminLinkProviderForUserRequest request, AsyncHandler<AdminLinkProviderForUserRequest,AdminLinkProviderForUserResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Links an existing user account in a user pool (DestinationUser) to an identity from an external
identity provider (SourceUser) based on a specified attribute name and value from the external
identity provider. This allows you to create a link from the existing user account to an external federated user
identity that has not yet been used to sign in, so that the federated user identity can be used to sign in as the
existing user account.
For example, if there is an existing user with a username and password, this API links that user to a federated user identity, so that when the federated user identity is used, the user signs in as the existing user account.
Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external identity providers and provider attributes that have been trusted by the application owner.
See also AdminDisableProviderForUser.
This action is enabled only for admin access and requires developer credentials.
adminLinkProviderForUserAsync in interface AWSCognitoIdentityProviderAsyncasyncHandler - 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.public Future<AdminListDevicesResult> adminListDevicesAsync(AdminListDevicesRequest request)
AWSCognitoIdentityProviderAsyncLists devices, as an administrator.
Requires developer credentials.
adminListDevicesAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to list devices, as an administrator.public Future<AdminListDevicesResult> adminListDevicesAsync(AdminListDevicesRequest request, AsyncHandler<AdminListDevicesRequest,AdminListDevicesResult> asyncHandler)
AWSCognitoIdentityProviderAsyncLists devices, as an administrator.
Requires developer credentials.
adminListDevicesAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to list devices, as an administrator.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AdminListGroupsForUserResult> adminListGroupsForUserAsync(AdminListGroupsForUserRequest request)
AWSCognitoIdentityProviderAsyncLists the groups that the user belongs to.
Requires developer credentials.
adminListGroupsForUserAsync in interface AWSCognitoIdentityProviderAsyncpublic Future<AdminListGroupsForUserResult> adminListGroupsForUserAsync(AdminListGroupsForUserRequest request, AsyncHandler<AdminListGroupsForUserRequest,AdminListGroupsForUserResult> asyncHandler)
AWSCognitoIdentityProviderAsyncLists the groups that the user belongs to.
Requires developer credentials.
adminListGroupsForUserAsync in interface AWSCognitoIdentityProviderAsyncasyncHandler - 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.public Future<AdminRemoveUserFromGroupResult> adminRemoveUserFromGroupAsync(AdminRemoveUserFromGroupRequest request)
AWSCognitoIdentityProviderAsyncRemoves the specified user from the specified group.
Requires developer credentials.
adminRemoveUserFromGroupAsync in interface AWSCognitoIdentityProviderAsyncpublic Future<AdminRemoveUserFromGroupResult> adminRemoveUserFromGroupAsync(AdminRemoveUserFromGroupRequest request, AsyncHandler<AdminRemoveUserFromGroupRequest,AdminRemoveUserFromGroupResult> asyncHandler)
AWSCognitoIdentityProviderAsyncRemoves the specified user from the specified group.
Requires developer credentials.
adminRemoveUserFromGroupAsync in interface AWSCognitoIdentityProviderAsyncasyncHandler - 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.public Future<AdminResetUserPasswordResult> adminResetUserPasswordAsync(AdminResetUserPasswordRequest request)
AWSCognitoIdentityProviderAsyncResets the specified user's password in a user pool as an administrator. Works on any user.
When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password.
Requires developer credentials.
adminResetUserPasswordAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to reset a user's password as an administrator.public Future<AdminResetUserPasswordResult> adminResetUserPasswordAsync(AdminResetUserPasswordRequest request, AsyncHandler<AdminResetUserPasswordRequest,AdminResetUserPasswordResult> asyncHandler)
AWSCognitoIdentityProviderAsyncResets the specified user's password in a user pool as an administrator. Works on any user.
When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password.
Requires developer credentials.
adminResetUserPasswordAsync in interface AWSCognitoIdentityProviderAsyncrequest - 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.public Future<AdminRespondToAuthChallengeResult> adminRespondToAuthChallengeAsync(AdminRespondToAuthChallengeRequest request)
AWSCognitoIdentityProviderAsyncResponds to an authentication challenge, as an administrator.
Requires developer credentials.
adminRespondToAuthChallengeAsync in interface AWSCognitoIdentityProviderAsyncrequest - The request to respond to the authentication challenge, as an administrator.public Future<AdminRespondToAuthChallengeResult> adminRespondToAuthChallengeAsync(AdminRespondToAuthChallengeRequest request, AsyncHandler<AdminRespondToAuthChallengeRequest,AdminRespondToAuthChallengeResult> asyncHandler)
AWSCognitoIdentityProviderAsyncResponds to an authentication challenge, as an administrator.
Requires developer credentials.
adminRespondToAuthChallengeAsync in interface AWSCognitoIdentityProviderAsyncrequest - The request to respond to the authentication challenge, as an administrator.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AdminSetUserSettingsResult> adminSetUserSettingsAsync(AdminSetUserSettingsRequest request)
AWSCognitoIdentityProviderAsyncSets all the user settings for a specified user name. Works on any user.
Requires developer credentials.
adminSetUserSettingsAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to set user settings as an administrator.public Future<AdminSetUserSettingsResult> adminSetUserSettingsAsync(AdminSetUserSettingsRequest request, AsyncHandler<AdminSetUserSettingsRequest,AdminSetUserSettingsResult> asyncHandler)
AWSCognitoIdentityProviderAsyncSets all the user settings for a specified user name. Works on any user.
Requires developer credentials.
adminSetUserSettingsAsync in interface AWSCognitoIdentityProviderAsyncrequest - 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.public Future<AdminUpdateDeviceStatusResult> adminUpdateDeviceStatusAsync(AdminUpdateDeviceStatusRequest request)
AWSCognitoIdentityProviderAsyncUpdates the device status as an administrator.
Requires developer credentials.
adminUpdateDeviceStatusAsync in interface AWSCognitoIdentityProviderAsyncrequest - The request to update the device status, as an administrator.public Future<AdminUpdateDeviceStatusResult> adminUpdateDeviceStatusAsync(AdminUpdateDeviceStatusRequest request, AsyncHandler<AdminUpdateDeviceStatusRequest,AdminUpdateDeviceStatusResult> asyncHandler)
AWSCognitoIdentityProviderAsyncUpdates the device status as an administrator.
Requires developer credentials.
adminUpdateDeviceStatusAsync in interface AWSCognitoIdentityProviderAsyncrequest - The request to update the device status, as an administrator.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AdminUpdateUserAttributesResult> adminUpdateUserAttributesAsync(AdminUpdateUserAttributesRequest request)
AWSCognitoIdentityProviderAsyncUpdates the specified user's attributes, including developer attributes, as an administrator. Works on any user.
For custom attributes, you must prepend the custom: prefix to the attribute name.
In addition to updating user attributes, this API can also be used to mark phone and email as verified.
Requires developer credentials.
adminUpdateUserAttributesAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to update the user's attributes as an administrator.public Future<AdminUpdateUserAttributesResult> adminUpdateUserAttributesAsync(AdminUpdateUserAttributesRequest request, AsyncHandler<AdminUpdateUserAttributesRequest,AdminUpdateUserAttributesResult> asyncHandler)
AWSCognitoIdentityProviderAsyncUpdates the specified user's attributes, including developer attributes, as an administrator. Works on any user.
For custom attributes, you must prepend the custom: prefix to the attribute name.
In addition to updating user attributes, this API can also be used to mark phone and email as verified.
Requires developer credentials.
adminUpdateUserAttributesAsync in interface AWSCognitoIdentityProviderAsyncrequest - 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.public Future<AdminUserGlobalSignOutResult> adminUserGlobalSignOutAsync(AdminUserGlobalSignOutRequest request)
AWSCognitoIdentityProviderAsyncSigns out users from all devices, as an administrator.
Requires developer credentials.
adminUserGlobalSignOutAsync in interface AWSCognitoIdentityProviderAsyncrequest - The request to sign out of all devices, as an administrator.public Future<AdminUserGlobalSignOutResult> adminUserGlobalSignOutAsync(AdminUserGlobalSignOutRequest request, AsyncHandler<AdminUserGlobalSignOutRequest,AdminUserGlobalSignOutResult> asyncHandler)
AWSCognitoIdentityProviderAsyncSigns out users from all devices, as an administrator.
Requires developer credentials.
adminUserGlobalSignOutAsync in interface AWSCognitoIdentityProviderAsyncrequest - The request to sign out of all devices, as an administrator.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ChangePasswordResult> changePasswordAsync(ChangePasswordRequest request)
AWSCognitoIdentityProviderAsyncChanges the password for a specified user in a user pool.
changePasswordAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to change a user password.public Future<ChangePasswordResult> changePasswordAsync(ChangePasswordRequest request, AsyncHandler<ChangePasswordRequest,ChangePasswordResult> asyncHandler)
AWSCognitoIdentityProviderAsyncChanges the password for a specified user in a user pool.
changePasswordAsync in interface AWSCognitoIdentityProviderAsyncrequest - 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.public Future<ConfirmDeviceResult> confirmDeviceAsync(ConfirmDeviceRequest request)
AWSCognitoIdentityProviderAsyncConfirms tracking of the device. This API call is the call that begins device tracking.
confirmDeviceAsync in interface AWSCognitoIdentityProviderAsyncrequest - Confirms the device request.public Future<ConfirmDeviceResult> confirmDeviceAsync(ConfirmDeviceRequest request, AsyncHandler<ConfirmDeviceRequest,ConfirmDeviceResult> asyncHandler)
AWSCognitoIdentityProviderAsyncConfirms tracking of the device. This API call is the call that begins device tracking.
confirmDeviceAsync in interface AWSCognitoIdentityProviderAsyncrequest - Confirms the device request.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ConfirmForgotPasswordResult> confirmForgotPasswordAsync(ConfirmForgotPasswordRequest request)
AWSCognitoIdentityProviderAsyncAllows a user to enter a confirmation code to reset a forgotten password.
confirmForgotPasswordAsync in interface AWSCognitoIdentityProviderAsyncrequest - The request representing the confirmation for a password reset.public Future<ConfirmForgotPasswordResult> confirmForgotPasswordAsync(ConfirmForgotPasswordRequest request, AsyncHandler<ConfirmForgotPasswordRequest,ConfirmForgotPasswordResult> asyncHandler)
AWSCognitoIdentityProviderAsyncAllows a user to enter a confirmation code to reset a forgotten password.
confirmForgotPasswordAsync in interface AWSCognitoIdentityProviderAsyncrequest - 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.public Future<ConfirmSignUpResult> confirmSignUpAsync(ConfirmSignUpRequest request)
AWSCognitoIdentityProviderAsyncConfirms registration of a user and handles the existing alias from a previous user.
confirmSignUpAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to confirm registration of a user.public Future<ConfirmSignUpResult> confirmSignUpAsync(ConfirmSignUpRequest request, AsyncHandler<ConfirmSignUpRequest,ConfirmSignUpResult> asyncHandler)
AWSCognitoIdentityProviderAsyncConfirms registration of a user and handles the existing alias from a previous user.
confirmSignUpAsync in interface AWSCognitoIdentityProviderAsyncrequest - 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.public Future<CreateGroupResult> createGroupAsync(CreateGroupRequest request)
AWSCognitoIdentityProviderAsyncCreates a new group in the specified user pool.
Requires developer credentials.
createGroupAsync in interface AWSCognitoIdentityProviderAsyncpublic Future<CreateGroupResult> createGroupAsync(CreateGroupRequest request, AsyncHandler<CreateGroupRequest,CreateGroupResult> asyncHandler)
AWSCognitoIdentityProviderAsyncCreates a new group in the specified user pool.
Requires developer credentials.
createGroupAsync in interface AWSCognitoIdentityProviderAsyncasyncHandler - 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.public Future<CreateIdentityProviderResult> createIdentityProviderAsync(CreateIdentityProviderRequest request)
AWSCognitoIdentityProviderAsyncCreates an identity provider for a user pool.
createIdentityProviderAsync in interface AWSCognitoIdentityProviderAsyncpublic Future<CreateIdentityProviderResult> createIdentityProviderAsync(CreateIdentityProviderRequest request, AsyncHandler<CreateIdentityProviderRequest,CreateIdentityProviderResult> asyncHandler)
AWSCognitoIdentityProviderAsyncCreates an identity provider for a user pool.
createIdentityProviderAsync in interface AWSCognitoIdentityProviderAsyncasyncHandler - 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.public Future<CreateResourceServerResult> createResourceServerAsync(CreateResourceServerRequest request)
AWSCognitoIdentityProviderAsyncCreates a new OAuth2.0 resource server and defines custom scopes in it.
createResourceServerAsync in interface AWSCognitoIdentityProviderAsyncpublic Future<CreateResourceServerResult> createResourceServerAsync(CreateResourceServerRequest request, AsyncHandler<CreateResourceServerRequest,CreateResourceServerResult> asyncHandler)
AWSCognitoIdentityProviderAsyncCreates a new OAuth2.0 resource server and defines custom scopes in it.
createResourceServerAsync in interface AWSCognitoIdentityProviderAsyncasyncHandler - 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.public Future<CreateUserImportJobResult> createUserImportJobAsync(CreateUserImportJobRequest request)
AWSCognitoIdentityProviderAsyncCreates the user import job.
createUserImportJobAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to create the user import job.public Future<CreateUserImportJobResult> createUserImportJobAsync(CreateUserImportJobRequest request, AsyncHandler<CreateUserImportJobRequest,CreateUserImportJobResult> asyncHandler)
AWSCognitoIdentityProviderAsyncCreates the user import job.
createUserImportJobAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to create the user import job.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateUserPoolResult> createUserPoolAsync(CreateUserPoolRequest request)
AWSCognitoIdentityProviderAsyncCreates a new Amazon Cognito user pool and sets the password policy for the pool.
createUserPoolAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to create a user pool.public Future<CreateUserPoolResult> createUserPoolAsync(CreateUserPoolRequest request, AsyncHandler<CreateUserPoolRequest,CreateUserPoolResult> asyncHandler)
AWSCognitoIdentityProviderAsyncCreates a new Amazon Cognito user pool and sets the password policy for the pool.
createUserPoolAsync in interface AWSCognitoIdentityProviderAsyncrequest - 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.public Future<CreateUserPoolClientResult> createUserPoolClientAsync(CreateUserPoolClientRequest request)
AWSCognitoIdentityProviderAsyncCreates the user pool client.
createUserPoolClientAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to create a user pool client.public Future<CreateUserPoolClientResult> createUserPoolClientAsync(CreateUserPoolClientRequest request, AsyncHandler<CreateUserPoolClientRequest,CreateUserPoolClientResult> asyncHandler)
AWSCognitoIdentityProviderAsyncCreates the user pool client.
createUserPoolClientAsync in interface AWSCognitoIdentityProviderAsyncrequest - 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.public Future<CreateUserPoolDomainResult> createUserPoolDomainAsync(CreateUserPoolDomainRequest request)
AWSCognitoIdentityProviderAsyncCreates a new domain for a user pool.
createUserPoolDomainAsync in interface AWSCognitoIdentityProviderAsyncpublic Future<CreateUserPoolDomainResult> createUserPoolDomainAsync(CreateUserPoolDomainRequest request, AsyncHandler<CreateUserPoolDomainRequest,CreateUserPoolDomainResult> asyncHandler)
AWSCognitoIdentityProviderAsyncCreates a new domain for a user pool.
createUserPoolDomainAsync in interface AWSCognitoIdentityProviderAsyncasyncHandler - 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.public Future<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest request)
AWSCognitoIdentityProviderAsyncDeletes a group. Currently only groups with no members can be deleted.
Requires developer credentials.
deleteGroupAsync in interface AWSCognitoIdentityProviderAsyncpublic Future<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest request, AsyncHandler<DeleteGroupRequest,DeleteGroupResult> asyncHandler)
AWSCognitoIdentityProviderAsyncDeletes a group. Currently only groups with no members can be deleted.
Requires developer credentials.
deleteGroupAsync in interface AWSCognitoIdentityProviderAsyncasyncHandler - 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.public Future<DeleteIdentityProviderResult> deleteIdentityProviderAsync(DeleteIdentityProviderRequest request)
AWSCognitoIdentityProviderAsyncDeletes an identity provider for a user pool.
deleteIdentityProviderAsync in interface AWSCognitoIdentityProviderAsyncpublic Future<DeleteIdentityProviderResult> deleteIdentityProviderAsync(DeleteIdentityProviderRequest request, AsyncHandler<DeleteIdentityProviderRequest,DeleteIdentityProviderResult> asyncHandler)
AWSCognitoIdentityProviderAsyncDeletes an identity provider for a user pool.
deleteIdentityProviderAsync in interface AWSCognitoIdentityProviderAsyncasyncHandler - 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.public Future<DeleteResourceServerResult> deleteResourceServerAsync(DeleteResourceServerRequest request)
AWSCognitoIdentityProviderAsyncDeletes a resource server.
deleteResourceServerAsync in interface AWSCognitoIdentityProviderAsyncpublic Future<DeleteResourceServerResult> deleteResourceServerAsync(DeleteResourceServerRequest request, AsyncHandler<DeleteResourceServerRequest,DeleteResourceServerResult> asyncHandler)
AWSCognitoIdentityProviderAsyncDeletes a resource server.
deleteResourceServerAsync in interface AWSCognitoIdentityProviderAsyncasyncHandler - 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.public Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest request)
AWSCognitoIdentityProviderAsyncAllows a user to delete himself or herself.
deleteUserAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to delete a user.public Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest request, AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)
AWSCognitoIdentityProviderAsyncAllows a user to delete himself or herself.
deleteUserAsync in interface AWSCognitoIdentityProviderAsyncrequest - 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.public Future<DeleteUserAttributesResult> deleteUserAttributesAsync(DeleteUserAttributesRequest request)
AWSCognitoIdentityProviderAsyncDeletes the attributes for a user.
deleteUserAttributesAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to delete user attributes.public Future<DeleteUserAttributesResult> deleteUserAttributesAsync(DeleteUserAttributesRequest request, AsyncHandler<DeleteUserAttributesRequest,DeleteUserAttributesResult> asyncHandler)
AWSCognitoIdentityProviderAsyncDeletes the attributes for a user.
deleteUserAttributesAsync in interface AWSCognitoIdentityProviderAsyncrequest - 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.public Future<DeleteUserPoolResult> deleteUserPoolAsync(DeleteUserPoolRequest request)
AWSCognitoIdentityProviderAsyncDeletes the specified Amazon Cognito user pool.
deleteUserPoolAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to delete a user pool.public Future<DeleteUserPoolResult> deleteUserPoolAsync(DeleteUserPoolRequest request, AsyncHandler<DeleteUserPoolRequest,DeleteUserPoolResult> asyncHandler)
AWSCognitoIdentityProviderAsyncDeletes the specified Amazon Cognito user pool.
deleteUserPoolAsync in interface AWSCognitoIdentityProviderAsyncrequest - 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.public Future<DeleteUserPoolClientResult> deleteUserPoolClientAsync(DeleteUserPoolClientRequest request)
AWSCognitoIdentityProviderAsyncAllows the developer to delete the user pool client.
deleteUserPoolClientAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to delete a user pool client.public Future<DeleteUserPoolClientResult> deleteUserPoolClientAsync(DeleteUserPoolClientRequest request, AsyncHandler<DeleteUserPoolClientRequest,DeleteUserPoolClientResult> asyncHandler)
AWSCognitoIdentityProviderAsyncAllows the developer to delete the user pool client.
deleteUserPoolClientAsync in interface AWSCognitoIdentityProviderAsyncrequest - 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.public Future<DeleteUserPoolDomainResult> deleteUserPoolDomainAsync(DeleteUserPoolDomainRequest request)
AWSCognitoIdentityProviderAsyncDeletes a domain for a user pool.
deleteUserPoolDomainAsync in interface AWSCognitoIdentityProviderAsyncpublic Future<DeleteUserPoolDomainResult> deleteUserPoolDomainAsync(DeleteUserPoolDomainRequest request, AsyncHandler<DeleteUserPoolDomainRequest,DeleteUserPoolDomainResult> asyncHandler)
AWSCognitoIdentityProviderAsyncDeletes a domain for a user pool.
deleteUserPoolDomainAsync in interface AWSCognitoIdentityProviderAsyncasyncHandler - 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.public Future<DescribeIdentityProviderResult> describeIdentityProviderAsync(DescribeIdentityProviderRequest request)
AWSCognitoIdentityProviderAsyncGets information about a specific identity provider.
describeIdentityProviderAsync in interface AWSCognitoIdentityProviderAsyncpublic Future<DescribeIdentityProviderResult> describeIdentityProviderAsync(DescribeIdentityProviderRequest request, AsyncHandler<DescribeIdentityProviderRequest,DescribeIdentityProviderResult> asyncHandler)
AWSCognitoIdentityProviderAsyncGets information about a specific identity provider.
describeIdentityProviderAsync in interface AWSCognitoIdentityProviderAsyncasyncHandler - 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.public Future<DescribeResourceServerResult> describeResourceServerAsync(DescribeResourceServerRequest request)
AWSCognitoIdentityProviderAsyncDescribes a resource server.
describeResourceServerAsync in interface AWSCognitoIdentityProviderAsyncpublic Future<DescribeResourceServerResult> describeResourceServerAsync(DescribeResourceServerRequest request, AsyncHandler<DescribeResourceServerRequest,DescribeResourceServerResult> asyncHandler)
AWSCognitoIdentityProviderAsyncDescribes a resource server.
describeResourceServerAsync in interface AWSCognitoIdentityProviderAsyncasyncHandler - 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.public Future<DescribeUserImportJobResult> describeUserImportJobAsync(DescribeUserImportJobRequest request)
AWSCognitoIdentityProviderAsyncDescribes the user import job.
describeUserImportJobAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to describe the user import job.public Future<DescribeUserImportJobResult> describeUserImportJobAsync(DescribeUserImportJobRequest request, AsyncHandler<DescribeUserImportJobRequest,DescribeUserImportJobResult> asyncHandler)
AWSCognitoIdentityProviderAsyncDescribes the user import job.
describeUserImportJobAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to describe the user import job.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeUserPoolResult> describeUserPoolAsync(DescribeUserPoolRequest request)
AWSCognitoIdentityProviderAsyncReturns the configuration information and metadata of the specified user pool.
describeUserPoolAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to describe the user pool.public Future<DescribeUserPoolResult> describeUserPoolAsync(DescribeUserPoolRequest request, AsyncHandler<DescribeUserPoolRequest,DescribeUserPoolResult> asyncHandler)
AWSCognitoIdentityProviderAsyncReturns the configuration information and metadata of the specified user pool.
describeUserPoolAsync in interface AWSCognitoIdentityProviderAsyncrequest - 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.public Future<DescribeUserPoolClientResult> describeUserPoolClientAsync(DescribeUserPoolClientRequest request)
AWSCognitoIdentityProviderAsyncClient method for returning the configuration information and metadata of the specified user pool client.
describeUserPoolClientAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to describe a user pool client.public Future<DescribeUserPoolClientResult> describeUserPoolClientAsync(DescribeUserPoolClientRequest request, AsyncHandler<DescribeUserPoolClientRequest,DescribeUserPoolClientResult> asyncHandler)
AWSCognitoIdentityProviderAsyncClient method for returning the configuration information and metadata of the specified user pool client.
describeUserPoolClientAsync in interface AWSCognitoIdentityProviderAsyncrequest - 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.public Future<DescribeUserPoolDomainResult> describeUserPoolDomainAsync(DescribeUserPoolDomainRequest request)
AWSCognitoIdentityProviderAsyncGets information about a domain.
describeUserPoolDomainAsync in interface AWSCognitoIdentityProviderAsyncpublic Future<DescribeUserPoolDomainResult> describeUserPoolDomainAsync(DescribeUserPoolDomainRequest request, AsyncHandler<DescribeUserPoolDomainRequest,DescribeUserPoolDomainResult> asyncHandler)
AWSCognitoIdentityProviderAsyncGets information about a domain.
describeUserPoolDomainAsync in interface AWSCognitoIdentityProviderAsyncasyncHandler - 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.public Future<ForgetDeviceResult> forgetDeviceAsync(ForgetDeviceRequest request)
AWSCognitoIdentityProviderAsyncForgets the specified device.
forgetDeviceAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to forget the device.public Future<ForgetDeviceResult> forgetDeviceAsync(ForgetDeviceRequest request, AsyncHandler<ForgetDeviceRequest,ForgetDeviceResult> asyncHandler)
AWSCognitoIdentityProviderAsyncForgets the specified device.
forgetDeviceAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to forget the device.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ForgotPasswordResult> forgotPasswordAsync(ForgotPasswordRequest request)
AWSCognitoIdentityProviderAsync
Calling this API causes a message to be sent to the end user with a confirmation code that is required to change
the user's password. For the Username parameter, you can use the username or user alias. If a
verified phone number exists for the user, the confirmation code is sent to the phone number. Otherwise, if a
verified email exists, the confirmation code is sent to the email. If neither a verified phone number nor a
verified email exists, InvalidParameterException is thrown. To use the confirmation code for
resetting the password, call ConfirmForgotPassword.
forgotPasswordAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to reset a user's password.public Future<ForgotPasswordResult> forgotPasswordAsync(ForgotPasswordRequest request, AsyncHandler<ForgotPasswordRequest,ForgotPasswordResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Calling this API causes a message to be sent to the end user with a confirmation code that is required to change
the user's password. For the Username parameter, you can use the username or user alias. If a
verified phone number exists for the user, the confirmation code is sent to the phone number. Otherwise, if a
verified email exists, the confirmation code is sent to the email. If neither a verified phone number nor a
verified email exists, InvalidParameterException is thrown. To use the confirmation code for
resetting the password, call ConfirmForgotPassword.
forgotPasswordAsync in interface AWSCognitoIdentityProviderAsyncrequest - 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.public Future<GetCSVHeaderResult> getCSVHeaderAsync(GetCSVHeaderRequest request)
AWSCognitoIdentityProviderAsyncGets the header information for the .csv file to be used as input for the user import job.
getCSVHeaderAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to get the header information for the .csv file for the user import job.public Future<GetCSVHeaderResult> getCSVHeaderAsync(GetCSVHeaderRequest request, AsyncHandler<GetCSVHeaderRequest,GetCSVHeaderResult> asyncHandler)
AWSCognitoIdentityProviderAsyncGets the header information for the .csv file to be used as input for the user import job.
getCSVHeaderAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to get the header information for the .csv file for the user import job.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetDeviceResult> getDeviceAsync(GetDeviceRequest request)
AWSCognitoIdentityProviderAsyncGets the device.
getDeviceAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to get the device.public Future<GetDeviceResult> getDeviceAsync(GetDeviceRequest request, AsyncHandler<GetDeviceRequest,GetDeviceResult> asyncHandler)
AWSCognitoIdentityProviderAsyncGets the device.
getDeviceAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to get the device.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetGroupResult> getGroupAsync(GetGroupRequest request)
AWSCognitoIdentityProviderAsyncGets a group.
Requires developer credentials.
getGroupAsync in interface AWSCognitoIdentityProviderAsyncpublic Future<GetGroupResult> getGroupAsync(GetGroupRequest request, AsyncHandler<GetGroupRequest,GetGroupResult> asyncHandler)
AWSCognitoIdentityProviderAsyncGets a group.
Requires developer credentials.
getGroupAsync in interface AWSCognitoIdentityProviderAsyncasyncHandler - 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.public Future<GetIdentityProviderByIdentifierResult> getIdentityProviderByIdentifierAsync(GetIdentityProviderByIdentifierRequest request)
AWSCognitoIdentityProviderAsyncGets the specified identity provider.
getIdentityProviderByIdentifierAsync in interface AWSCognitoIdentityProviderAsyncpublic Future<GetIdentityProviderByIdentifierResult> getIdentityProviderByIdentifierAsync(GetIdentityProviderByIdentifierRequest request, AsyncHandler<GetIdentityProviderByIdentifierRequest,GetIdentityProviderByIdentifierResult> asyncHandler)
AWSCognitoIdentityProviderAsyncGets the specified identity provider.
getIdentityProviderByIdentifierAsync in interface AWSCognitoIdentityProviderAsyncasyncHandler - 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.public Future<GetUICustomizationResult> getUICustomizationAsync(GetUICustomizationRequest request)
AWSCognitoIdentityProviderAsync
Gets the UI Customization information for a particular app client's app UI, if there is something set. If nothing
is set for the particular client, but there is an existing pool level customization (app clientId
will be ALL), then that is returned. If nothing is present, then an empty shape is returned.
getUICustomizationAsync in interface AWSCognitoIdentityProviderAsyncpublic Future<GetUICustomizationResult> getUICustomizationAsync(GetUICustomizationRequest request, AsyncHandler<GetUICustomizationRequest,GetUICustomizationResult> asyncHandler)
AWSCognitoIdentityProviderAsync
Gets the UI Customization information for a particular app client's app UI, if there is something set. If nothing
is set for the particular client, but there is an existing pool level customization (app clientId
will be ALL), then that is returned. If nothing is present, then an empty shape is returned.
getUICustomizationAsync in interface AWSCognitoIdentityProviderAsyncasyncHandler - 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.public Future<GetUserResult> getUserAsync(GetUserRequest request)
AWSCognitoIdentityProviderAsyncGets the user attributes and metadata for a user.
getUserAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to get information about the user.public Future<GetUserResult> getUserAsync(GetUserRequest request, AsyncHandler<GetUserRequest,GetUserResult> asyncHandler)
AWSCognitoIdentityProviderAsyncGets the user attributes and metadata for a user.
getUserAsync in interface AWSCognitoIdentityProviderAsyncrequest - 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.public Future<GetUserAttributeVerificationCodeResult> getUserAttributeVerificationCodeAsync(GetUserAttributeVerificationCodeRequest request)
AWSCognitoIdentityProviderAsyncGets the user attribute verification code for the specified attribute name.
getUserAttributeVerificationCodeAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to get user attribute verification.public Future<GetUserAttributeVerificationCodeResult> getUserAttributeVerificationCodeAsync(GetUserAttributeVerificationCodeRequest request, AsyncHandler<GetUserAttributeVerificationCodeRequest,GetUserAttributeVerificationCodeResult> asyncHandler)
AWSCognitoIdentityProviderAsyncGets the user attribute verification code for the specified attribute name.
getUserAttributeVerificationCodeAsync in interface AWSCognitoIdentityProviderAsyncrequest - 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.public Future<GlobalSignOutResult> globalSignOutAsync(GlobalSignOutRequest request)
AWSCognitoIdentityProviderAsyncSigns out users from all devices.
globalSignOutAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to sign out all devices.public Future<GlobalSignOutResult> globalSignOutAsync(GlobalSignOutRequest request, AsyncHandler<GlobalSignOutRequest,GlobalSignOutResult> asyncHandler)
AWSCognitoIdentityProviderAsyncSigns out users from all devices.
globalSignOutAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to sign out all devices.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<InitiateAuthResult> initiateAuthAsync(InitiateAuthRequest request)
AWSCognitoIdentityProviderAsyncInitiates the authentication flow.
initiateAuthAsync in interface AWSCognitoIdentityProviderAsyncrequest - Initiates the authentication request.public Future<InitiateAuthResult> initiateAuthAsync(InitiateAuthRequest request, AsyncHandler<InitiateAuthRequest,InitiateAuthResult> asyncHandler)
AWSCognitoIdentityProviderAsyncInitiates the authentication flow.
initiateAuthAsync in interface AWSCognitoIdentityProviderAsyncrequest - Initiates the authentication request.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListDevicesResult> listDevicesAsync(ListDevicesRequest request)
AWSCognitoIdentityProviderAsyncLists the devices.
listDevicesAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to list the devices.public Future<ListDevicesResult> listDevicesAsync(ListDevicesRequest request, AsyncHandler<ListDevicesRequest,ListDevicesResult> asyncHandler)
AWSCognitoIdentityProviderAsyncLists the devices.
listDevicesAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to list the devices.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListGroupsResult> listGroupsAsync(ListGroupsRequest request)
AWSCognitoIdentityProviderAsyncLists the groups associated with a user pool.
Requires developer credentials.
listGroupsAsync in interface AWSCognitoIdentityProviderAsyncpublic Future<ListGroupsResult> listGroupsAsync(ListGroupsRequest request, AsyncHandler<ListGroupsRequest,ListGroupsResult> asyncHandler)
AWSCognitoIdentityProviderAsyncLists the groups associated with a user pool.
Requires developer credentials.
listGroupsAsync in interface AWSCognitoIdentityProviderAsyncasyncHandler - 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.public Future<ListIdentityProvidersResult> listIdentityProvidersAsync(ListIdentityProvidersRequest request)
AWSCognitoIdentityProviderAsyncLists information about all identity providers for a user pool.
listIdentityProvidersAsync in interface AWSCognitoIdentityProviderAsyncpublic Future<ListIdentityProvidersResult> listIdentityProvidersAsync(ListIdentityProvidersRequest request, AsyncHandler<ListIdentityProvidersRequest,ListIdentityProvidersResult> asyncHandler)
AWSCognitoIdentityProviderAsyncLists information about all identity providers for a user pool.
listIdentityProvidersAsync in interface AWSCognitoIdentityProviderAsyncasyncHandler - 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.public Future<ListResourceServersResult> listResourceServersAsync(ListResourceServersRequest request)
AWSCognitoIdentityProviderAsyncLists the resource servers for a user pool.
listResourceServersAsync in interface AWSCognitoIdentityProviderAsyncpublic Future<ListResourceServersResult> listResourceServersAsync(ListResourceServersRequest request, AsyncHandler<ListResourceServersRequest,ListResourceServersResult> asyncHandler)
AWSCognitoIdentityProviderAsyncLists the resource servers for a user pool.
listResourceServersAsync in interface AWSCognitoIdentityProviderAsyncasyncHandler - 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.public Future<ListUserImportJobsResult> listUserImportJobsAsync(ListUserImportJobsRequest request)
AWSCognitoIdentityProviderAsyncLists the user import jobs.
listUserImportJobsAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to list the user import jobs.public Future<ListUserImportJobsResult> listUserImportJobsAsync(ListUserImportJobsRequest request, AsyncHandler<ListUserImportJobsRequest,ListUserImportJobsResult> asyncHandler)
AWSCognitoIdentityProviderAsyncLists the user import jobs.
listUserImportJobsAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to list the user import jobs.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListUserPoolClientsResult> listUserPoolClientsAsync(ListUserPoolClientsRequest request)
AWSCognitoIdentityProviderAsyncLists the clients that have been created for the specified user pool.
listUserPoolClientsAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to list the user pool clients.public Future<ListUserPoolClientsResult> listUserPoolClientsAsync(ListUserPoolClientsRequest request, AsyncHandler<ListUserPoolClientsRequest,ListUserPoolClientsResult> asyncHandler)
AWSCognitoIdentityProviderAsyncLists the clients that have been created for the specified user pool.
listUserPoolClientsAsync in interface AWSCognitoIdentityProviderAsyncrequest - 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.public Future<ListUserPoolsResult> listUserPoolsAsync(ListUserPoolsRequest request)
AWSCognitoIdentityProviderAsyncLists the user pools associated with an AWS account.
listUserPoolsAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to list user pools.public Future<ListUserPoolsResult> listUserPoolsAsync(ListUserPoolsRequest request, AsyncHandler<ListUserPoolsRequest,ListUserPoolsResult> asyncHandler)
AWSCognitoIdentityProviderAsyncLists the user pools associated with an AWS account.
listUserPoolsAsync in interface AWSCognitoIdentityProviderAsyncrequest - 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.public Future<ListUsersResult> listUsersAsync(ListUsersRequest request)
AWSCognitoIdentityProviderAsyncLists the users in the Amazon Cognito user pool.
listUsersAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to list users.public Future<ListUsersResult> listUsersAsync(ListUsersRequest request, AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler)
AWSCognitoIdentityProviderAsyncLists the users in the Amazon Cognito user pool.
listUsersAsync in interface AWSCognitoIdentityProviderAsyncrequest - 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.public Future<ListUsersInGroupResult> listUsersInGroupAsync(ListUsersInGroupRequest request)
AWSCognitoIdentityProviderAsyncLists the users in the specified group.
Requires developer credentials.
listUsersInGroupAsync in interface AWSCognitoIdentityProviderAsyncpublic Future<ListUsersInGroupResult> listUsersInGroupAsync(ListUsersInGroupRequest request, AsyncHandler<ListUsersInGroupRequest,ListUsersInGroupResult> asyncHandler)
AWSCognitoIdentityProviderAsyncLists the users in the specified group.
Requires developer credentials.
listUsersInGroupAsync in interface AWSCognitoIdentityProviderAsyncasyncHandler - 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.public Future<ResendConfirmationCodeResult> resendConfirmationCodeAsync(ResendConfirmationCodeRequest request)
AWSCognitoIdentityProviderAsyncResends the confirmation (for confirmation of registration) to a specific user in the user pool.
resendConfirmationCodeAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to resend the confirmation code.public Future<ResendConfirmationCodeResult> resendConfirmationCodeAsync(ResendConfirmationCodeRequest request, AsyncHandler<ResendConfirmationCodeRequest,ResendConfirmationCodeResult> asyncHandler)
AWSCognitoIdentityProviderAsyncResends the confirmation (for confirmation of registration) to a specific user in the user pool.
resendConfirmationCodeAsync in interface AWSCognitoIdentityProviderAsyncrequest - 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.public Future<RespondToAuthChallengeResult> respondToAuthChallengeAsync(RespondToAuthChallengeRequest request)
AWSCognitoIdentityProviderAsyncResponds to the authentication challenge.
respondToAuthChallengeAsync in interface AWSCognitoIdentityProviderAsyncrequest - The request to respond to an authentication challenge.public Future<RespondToAuthChallengeResult> respondToAuthChallengeAsync(RespondToAuthChallengeRequest request, AsyncHandler<RespondToAuthChallengeRequest,RespondToAuthChallengeResult> asyncHandler)
AWSCognitoIdentityProviderAsyncResponds to the authentication challenge.
respondToAuthChallengeAsync in interface AWSCognitoIdentityProviderAsyncrequest - The request to respond to an authentication challenge.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SetUICustomizationResult> setUICustomizationAsync(SetUICustomizationRequest request)
AWSCognitoIdentityProviderAsyncSets the UI customization information for a user pool's built-in app UI.
You can specify app UI customization settings for a single client (with a specific clientId) or for
all clients (by setting the clientId to ALL). If you specify ALL, the
default configuration will be used for every client that has no UI customization set previously. If you specify
UI customization settings for a particular client, it will no longer fall back to the ALL
configuration.
To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app's pages, and the service will throw an error.
setUICustomizationAsync in interface AWSCognitoIdentityProviderAsyncpublic Future<SetUICustomizationResult> setUICustomizationAsync(SetUICustomizationRequest request, AsyncHandler<SetUICustomizationRequest,SetUICustomizationResult> asyncHandler)
AWSCognitoIdentityProviderAsyncSets the UI customization information for a user pool's built-in app UI.
You can specify app UI customization settings for a single client (with a specific clientId) or for
all clients (by setting the clientId to ALL). If you specify ALL, the
default configuration will be used for every client that has no UI customization set previously. If you specify
UI customization settings for a particular client, it will no longer fall back to the ALL
configuration.
To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app's pages, and the service will throw an error.
setUICustomizationAsync in interface AWSCognitoIdentityProviderAsyncasyncHandler - 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.public Future<SetUserSettingsResult> setUserSettingsAsync(SetUserSettingsRequest request)
AWSCognitoIdentityProviderAsyncSets 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.
setUserSettingsAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to set user settings.public Future<SetUserSettingsResult> setUserSettingsAsync(SetUserSettingsRequest request, AsyncHandler<SetUserSettingsRequest,SetUserSettingsResult> asyncHandler)
AWSCognitoIdentityProviderAsyncSets 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.
setUserSettingsAsync in interface AWSCognitoIdentityProviderAsyncrequest - 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.public Future<SignUpResult> signUpAsync(SignUpRequest request)
AWSCognitoIdentityProviderAsyncRegisters the user in the specified user pool and creates a user name, password, and user attributes.
signUpAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to register a user.public Future<SignUpResult> signUpAsync(SignUpRequest request, AsyncHandler<SignUpRequest,SignUpResult> asyncHandler)
AWSCognitoIdentityProviderAsyncRegisters the user in the specified user pool and creates a user name, password, and user attributes.
signUpAsync in interface AWSCognitoIdentityProviderAsyncrequest - 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.public Future<StartUserImportJobResult> startUserImportJobAsync(StartUserImportJobRequest request)
AWSCognitoIdentityProviderAsyncStarts the user import.
startUserImportJobAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to start the user import job.public Future<StartUserImportJobResult> startUserImportJobAsync(StartUserImportJobRequest request, AsyncHandler<StartUserImportJobRequest,StartUserImportJobResult> asyncHandler)
AWSCognitoIdentityProviderAsyncStarts the user import.
startUserImportJobAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to start the user import job.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StopUserImportJobResult> stopUserImportJobAsync(StopUserImportJobRequest request)
AWSCognitoIdentityProviderAsyncStops the user import job.
stopUserImportJobAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to stop the user import job.public Future<StopUserImportJobResult> stopUserImportJobAsync(StopUserImportJobRequest request, AsyncHandler<StopUserImportJobRequest,StopUserImportJobResult> asyncHandler)
AWSCognitoIdentityProviderAsyncStops the user import job.
stopUserImportJobAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to stop the user import job.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateDeviceStatusResult> updateDeviceStatusAsync(UpdateDeviceStatusRequest request)
AWSCognitoIdentityProviderAsyncUpdates the device status.
updateDeviceStatusAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to update the device status.public Future<UpdateDeviceStatusResult> updateDeviceStatusAsync(UpdateDeviceStatusRequest request, AsyncHandler<UpdateDeviceStatusRequest,UpdateDeviceStatusResult> asyncHandler)
AWSCognitoIdentityProviderAsyncUpdates the device status.
updateDeviceStatusAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to update the device status.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateGroupResult> updateGroupAsync(UpdateGroupRequest request)
AWSCognitoIdentityProviderAsyncUpdates the specified group with the specified attributes.
Requires developer credentials.
updateGroupAsync in interface AWSCognitoIdentityProviderAsyncpublic Future<UpdateGroupResult> updateGroupAsync(UpdateGroupRequest request, AsyncHandler<UpdateGroupRequest,UpdateGroupResult> asyncHandler)
AWSCognitoIdentityProviderAsyncUpdates the specified group with the specified attributes.
Requires developer credentials.
updateGroupAsync in interface AWSCognitoIdentityProviderAsyncasyncHandler - 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.public Future<UpdateIdentityProviderResult> updateIdentityProviderAsync(UpdateIdentityProviderRequest request)
AWSCognitoIdentityProviderAsyncUpdates identity provider information for a user pool.
updateIdentityProviderAsync in interface AWSCognitoIdentityProviderAsyncpublic Future<UpdateIdentityProviderResult> updateIdentityProviderAsync(UpdateIdentityProviderRequest request, AsyncHandler<UpdateIdentityProviderRequest,UpdateIdentityProviderResult> asyncHandler)
AWSCognitoIdentityProviderAsyncUpdates identity provider information for a user pool.
updateIdentityProviderAsync in interface AWSCognitoIdentityProviderAsyncasyncHandler - 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.public Future<UpdateResourceServerResult> updateResourceServerAsync(UpdateResourceServerRequest request)
AWSCognitoIdentityProviderAsyncUpdates the name and scopes of resource server. All other fields are read-only.
updateResourceServerAsync in interface AWSCognitoIdentityProviderAsyncpublic Future<UpdateResourceServerResult> updateResourceServerAsync(UpdateResourceServerRequest request, AsyncHandler<UpdateResourceServerRequest,UpdateResourceServerResult> asyncHandler)
AWSCognitoIdentityProviderAsyncUpdates the name and scopes of resource server. All other fields are read-only.
updateResourceServerAsync in interface AWSCognitoIdentityProviderAsyncasyncHandler - 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.public Future<UpdateUserAttributesResult> updateUserAttributesAsync(UpdateUserAttributesRequest request)
AWSCognitoIdentityProviderAsyncAllows a user to update a specific attribute (one at a time).
updateUserAttributesAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to update user attributes.public Future<UpdateUserAttributesResult> updateUserAttributesAsync(UpdateUserAttributesRequest request, AsyncHandler<UpdateUserAttributesRequest,UpdateUserAttributesResult> asyncHandler)
AWSCognitoIdentityProviderAsyncAllows a user to update a specific attribute (one at a time).
updateUserAttributesAsync in interface AWSCognitoIdentityProviderAsyncrequest - 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.public Future<UpdateUserPoolResult> updateUserPoolAsync(UpdateUserPoolRequest request)
AWSCognitoIdentityProviderAsyncUpdates the specified user pool with the specified attributes.
updateUserPoolAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to update the user pool.public Future<UpdateUserPoolResult> updateUserPoolAsync(UpdateUserPoolRequest request, AsyncHandler<UpdateUserPoolRequest,UpdateUserPoolResult> asyncHandler)
AWSCognitoIdentityProviderAsyncUpdates the specified user pool with the specified attributes.
updateUserPoolAsync in interface AWSCognitoIdentityProviderAsyncrequest - 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.public Future<UpdateUserPoolClientResult> updateUserPoolClientAsync(UpdateUserPoolClientRequest request)
AWSCognitoIdentityProviderAsyncAllows the developer to update the specified user pool client and password policy.
updateUserPoolClientAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to update the user pool client.public Future<UpdateUserPoolClientResult> updateUserPoolClientAsync(UpdateUserPoolClientRequest request, AsyncHandler<UpdateUserPoolClientRequest,UpdateUserPoolClientResult> asyncHandler)
AWSCognitoIdentityProviderAsyncAllows the developer to update the specified user pool client and password policy.
updateUserPoolClientAsync in interface AWSCognitoIdentityProviderAsyncrequest - 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.public Future<VerifyUserAttributeResult> verifyUserAttributeAsync(VerifyUserAttributeRequest request)
AWSCognitoIdentityProviderAsyncVerifies the specified user attributes in the user pool.
verifyUserAttributeAsync in interface AWSCognitoIdentityProviderAsyncrequest - Represents the request to verify user attributes.public Future<VerifyUserAttributeResult> verifyUserAttributeAsync(VerifyUserAttributeRequest request, AsyncHandler<VerifyUserAttributeRequest,VerifyUserAttributeResult> asyncHandler)
AWSCognitoIdentityProviderAsyncVerifies the specified user attributes in the user pool.
verifyUserAttributeAsync in interface AWSCognitoIdentityProviderAsyncrequest - 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.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AWSCognitoIdentityProvidershutdown in class AmazonWebServiceClientCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.