@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSCognitoIdentityProviderAsync extends AWSCognitoIdentityProvider
AsyncHandler can be used to
receive notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSCognitoIdentityProviderAsync instead.
Using the Amazon Cognito 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.
ENDPOINT_PREFIXaddCustomAttributes, 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, shutdown, signUp, startUserImportJob, stopUserImportJob, updateDeviceStatus, updateGroup, updateIdentityProvider, updateResourceServer, updateUserAttributes, updateUserPool, updateUserPoolClient, verifyUserAttributeFuture<AddCustomAttributesResult> addCustomAttributesAsync(AddCustomAttributesRequest addCustomAttributesRequest)
Adds additional user attributes to the user pool schema.
addCustomAttributesRequest - Represents the request to add custom attributes.Future<AddCustomAttributesResult> addCustomAttributesAsync(AddCustomAttributesRequest addCustomAttributesRequest, AsyncHandler<AddCustomAttributesRequest,AddCustomAttributesResult> asyncHandler)
Adds additional user attributes to the user pool schema.
addCustomAttributesRequest - Represents the request to add custom attributes.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<AdminAddUserToGroupResult> adminAddUserToGroupAsync(AdminAddUserToGroupRequest adminAddUserToGroupRequest)
Adds the specified user to the specified group.
Requires developer credentials.
adminAddUserToGroupRequest - Future<AdminAddUserToGroupResult> adminAddUserToGroupAsync(AdminAddUserToGroupRequest adminAddUserToGroupRequest, AsyncHandler<AdminAddUserToGroupRequest,AdminAddUserToGroupResult> asyncHandler)
Adds the specified user to the specified group.
Requires developer credentials.
adminAddUserToGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<AdminConfirmSignUpResult> adminConfirmSignUpAsync(AdminConfirmSignUpRequest adminConfirmSignUpRequest)
Confirms user registration as an admin without using a confirmation code. Works on any user.
Requires developer credentials.
adminConfirmSignUpRequest - Represents the request to confirm user registration.Future<AdminConfirmSignUpResult> adminConfirmSignUpAsync(AdminConfirmSignUpRequest adminConfirmSignUpRequest, AsyncHandler<AdminConfirmSignUpRequest,AdminConfirmSignUpResult> asyncHandler)
Confirms user registration as an admin without using a confirmation code. Works on any user.
Requires developer credentials.
adminConfirmSignUpRequest - Represents the request to confirm user registration.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<AdminCreateUserResult> adminCreateUserAsync(AdminCreateUserRequest adminCreateUserRequest)
Creates a new user in the specified user pool and sends a welcome message via email or phone (SMS). This message is based on a template that you configured in your call to CreateUserPool or UpdateUserPool. This template includes your custom sign-up instructions and placeholders for user name and temporary password.
Requires developer credentials.
adminCreateUserRequest - Represents the request to create a user in the specified user pool.Future<AdminCreateUserResult> adminCreateUserAsync(AdminCreateUserRequest adminCreateUserRequest, AsyncHandler<AdminCreateUserRequest,AdminCreateUserResult> asyncHandler)
Creates a new user in the specified user pool and sends a welcome message via email or phone (SMS). This message is based on a template that you configured in your call to CreateUserPool or UpdateUserPool. This template includes your custom sign-up instructions and placeholders for user name and temporary password.
Requires developer credentials.
adminCreateUserRequest - Represents the request to create a user in the specified user pool.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<AdminDeleteUserResult> adminDeleteUserAsync(AdminDeleteUserRequest adminDeleteUserRequest)
Deletes a user as an administrator. Works on any user.
Requires developer credentials.
adminDeleteUserRequest - Represents the request to delete a user as an administrator.Future<AdminDeleteUserResult> adminDeleteUserAsync(AdminDeleteUserRequest adminDeleteUserRequest, AsyncHandler<AdminDeleteUserRequest,AdminDeleteUserResult> asyncHandler)
Deletes a user as an administrator. Works on any user.
Requires developer credentials.
adminDeleteUserRequest - Represents the request to delete a user as an administrator.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<AdminDeleteUserAttributesResult> adminDeleteUserAttributesAsync(AdminDeleteUserAttributesRequest adminDeleteUserAttributesRequest)
Deletes the user attributes in a user pool as an administrator. Works on any user.
Requires developer credentials.
adminDeleteUserAttributesRequest - Represents the request to delete user attributes as an administrator.Future<AdminDeleteUserAttributesResult> adminDeleteUserAttributesAsync(AdminDeleteUserAttributesRequest adminDeleteUserAttributesRequest, AsyncHandler<AdminDeleteUserAttributesRequest,AdminDeleteUserAttributesResult> asyncHandler)
Deletes the user attributes in a user pool as an administrator. Works on any user.
Requires developer credentials.
adminDeleteUserAttributesRequest - Represents the request to delete user attributes as an administrator.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<AdminDisableProviderForUserResult> adminDisableProviderForUserAsync(AdminDisableProviderForUserRequest adminDisableProviderForUserRequest)
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.
adminDisableProviderForUserRequest - Future<AdminDisableProviderForUserResult> adminDisableProviderForUserAsync(AdminDisableProviderForUserRequest adminDisableProviderForUserRequest, AsyncHandler<AdminDisableProviderForUserRequest,AdminDisableProviderForUserResult> asyncHandler)
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.
adminDisableProviderForUserRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<AdminDisableUserResult> adminDisableUserAsync(AdminDisableUserRequest adminDisableUserRequest)
Disables the specified user as an administrator. Works on any user.
Requires developer credentials.
adminDisableUserRequest - Represents the request to disable any user as an administrator.Future<AdminDisableUserResult> adminDisableUserAsync(AdminDisableUserRequest adminDisableUserRequest, AsyncHandler<AdminDisableUserRequest,AdminDisableUserResult> asyncHandler)
Disables the specified user as an administrator. Works on any user.
Requires developer credentials.
adminDisableUserRequest - Represents the request to disable any user as an administrator.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<AdminEnableUserResult> adminEnableUserAsync(AdminEnableUserRequest adminEnableUserRequest)
Enables the specified user as an administrator. Works on any user.
Requires developer credentials.
adminEnableUserRequest - Represents the request that enables the user as an administrator.Future<AdminEnableUserResult> adminEnableUserAsync(AdminEnableUserRequest adminEnableUserRequest, AsyncHandler<AdminEnableUserRequest,AdminEnableUserResult> asyncHandler)
Enables the specified user as an administrator. Works on any user.
Requires developer credentials.
adminEnableUserRequest - Represents the request that enables the user as an administrator.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<AdminForgetDeviceResult> adminForgetDeviceAsync(AdminForgetDeviceRequest adminForgetDeviceRequest)
Forgets the device, as an administrator.
Requires developer credentials.
adminForgetDeviceRequest - Sends the forgot device request, as an administrator.Future<AdminForgetDeviceResult> adminForgetDeviceAsync(AdminForgetDeviceRequest adminForgetDeviceRequest, AsyncHandler<AdminForgetDeviceRequest,AdminForgetDeviceResult> asyncHandler)
Forgets the device, as an administrator.
Requires developer credentials.
adminForgetDeviceRequest - Sends the forgot device request, as an administrator.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<AdminGetDeviceResult> adminGetDeviceAsync(AdminGetDeviceRequest adminGetDeviceRequest)
Gets the device, as an administrator.
Requires developer credentials.
adminGetDeviceRequest - Represents the request to get the device, as an administrator.Future<AdminGetDeviceResult> adminGetDeviceAsync(AdminGetDeviceRequest adminGetDeviceRequest, AsyncHandler<AdminGetDeviceRequest,AdminGetDeviceResult> asyncHandler)
Gets the device, as an administrator.
Requires developer credentials.
adminGetDeviceRequest - Represents the request to get the device, as an administrator.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<AdminGetUserResult> adminGetUserAsync(AdminGetUserRequest adminGetUserRequest)
Gets the specified user by user name in a user pool as an administrator. Works on any user.
Requires developer credentials.
adminGetUserRequest - Represents the request to get the specified user as an administrator.Future<AdminGetUserResult> adminGetUserAsync(AdminGetUserRequest adminGetUserRequest, AsyncHandler<AdminGetUserRequest,AdminGetUserResult> asyncHandler)
Gets the specified user by user name in a user pool as an administrator. Works on any user.
Requires developer credentials.
adminGetUserRequest - Represents the request to get the specified user as an administrator.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<AdminInitiateAuthResult> adminInitiateAuthAsync(AdminInitiateAuthRequest adminInitiateAuthRequest)
Initiates the authentication flow, as an administrator.
Requires developer credentials.
adminInitiateAuthRequest - Initiates the authorization request, as an administrator.Future<AdminInitiateAuthResult> adminInitiateAuthAsync(AdminInitiateAuthRequest adminInitiateAuthRequest, AsyncHandler<AdminInitiateAuthRequest,AdminInitiateAuthResult> asyncHandler)
Initiates the authentication flow, as an administrator.
Requires developer credentials.
adminInitiateAuthRequest - Initiates the authorization request, as an administrator.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<AdminLinkProviderForUserResult> adminLinkProviderForUserAsync(AdminLinkProviderForUserRequest adminLinkProviderForUserRequest)
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.
adminLinkProviderForUserRequest - Future<AdminLinkProviderForUserResult> adminLinkProviderForUserAsync(AdminLinkProviderForUserRequest adminLinkProviderForUserRequest, AsyncHandler<AdminLinkProviderForUserRequest,AdminLinkProviderForUserResult> asyncHandler)
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.
adminLinkProviderForUserRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<AdminListDevicesResult> adminListDevicesAsync(AdminListDevicesRequest adminListDevicesRequest)
Lists devices, as an administrator.
Requires developer credentials.
adminListDevicesRequest - Represents the request to list devices, as an administrator.Future<AdminListDevicesResult> adminListDevicesAsync(AdminListDevicesRequest adminListDevicesRequest, AsyncHandler<AdminListDevicesRequest,AdminListDevicesResult> asyncHandler)
Lists devices, as an administrator.
Requires developer credentials.
adminListDevicesRequest - Represents the request to list devices, as an administrator.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<AdminListGroupsForUserResult> adminListGroupsForUserAsync(AdminListGroupsForUserRequest adminListGroupsForUserRequest)
Lists the groups that the user belongs to.
Requires developer credentials.
adminListGroupsForUserRequest - Future<AdminListGroupsForUserResult> adminListGroupsForUserAsync(AdminListGroupsForUserRequest adminListGroupsForUserRequest, AsyncHandler<AdminListGroupsForUserRequest,AdminListGroupsForUserResult> asyncHandler)
Lists the groups that the user belongs to.
Requires developer credentials.
adminListGroupsForUserRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<AdminRemoveUserFromGroupResult> adminRemoveUserFromGroupAsync(AdminRemoveUserFromGroupRequest adminRemoveUserFromGroupRequest)
Removes the specified user from the specified group.
Requires developer credentials.
adminRemoveUserFromGroupRequest - Future<AdminRemoveUserFromGroupResult> adminRemoveUserFromGroupAsync(AdminRemoveUserFromGroupRequest adminRemoveUserFromGroupRequest, AsyncHandler<AdminRemoveUserFromGroupRequest,AdminRemoveUserFromGroupResult> asyncHandler)
Removes the specified user from the specified group.
Requires developer credentials.
adminRemoveUserFromGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<AdminResetUserPasswordResult> adminResetUserPasswordAsync(AdminResetUserPasswordRequest adminResetUserPasswordRequest)
Resets the specified user's password in a user pool as an administrator. Works on any user.
When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password.
Requires developer credentials.
adminResetUserPasswordRequest - Represents the request to reset a user's password as an administrator.Future<AdminResetUserPasswordResult> adminResetUserPasswordAsync(AdminResetUserPasswordRequest adminResetUserPasswordRequest, AsyncHandler<AdminResetUserPasswordRequest,AdminResetUserPasswordResult> asyncHandler)
Resets the specified user's password in a user pool as an administrator. Works on any user.
When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password.
Requires developer credentials.
adminResetUserPasswordRequest - Represents the request to reset a user's password as an administrator.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<AdminRespondToAuthChallengeResult> adminRespondToAuthChallengeAsync(AdminRespondToAuthChallengeRequest adminRespondToAuthChallengeRequest)
Responds to an authentication challenge, as an administrator.
Requires developer credentials.
adminRespondToAuthChallengeRequest - The request to respond to the authentication challenge, as an administrator.Future<AdminRespondToAuthChallengeResult> adminRespondToAuthChallengeAsync(AdminRespondToAuthChallengeRequest adminRespondToAuthChallengeRequest, AsyncHandler<AdminRespondToAuthChallengeRequest,AdminRespondToAuthChallengeResult> asyncHandler)
Responds to an authentication challenge, as an administrator.
Requires developer credentials.
adminRespondToAuthChallengeRequest - The request to respond to the authentication challenge, as an administrator.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<AdminSetUserSettingsResult> adminSetUserSettingsAsync(AdminSetUserSettingsRequest adminSetUserSettingsRequest)
Sets all the user settings for a specified user name. Works on any user.
Requires developer credentials.
adminSetUserSettingsRequest - Represents the request to set user settings as an administrator.Future<AdminSetUserSettingsResult> adminSetUserSettingsAsync(AdminSetUserSettingsRequest adminSetUserSettingsRequest, AsyncHandler<AdminSetUserSettingsRequest,AdminSetUserSettingsResult> asyncHandler)
Sets all the user settings for a specified user name. Works on any user.
Requires developer credentials.
adminSetUserSettingsRequest - Represents the request to set user settings as an administrator.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<AdminUpdateDeviceStatusResult> adminUpdateDeviceStatusAsync(AdminUpdateDeviceStatusRequest adminUpdateDeviceStatusRequest)
Updates the device status as an administrator.
Requires developer credentials.
adminUpdateDeviceStatusRequest - The request to update the device status, as an administrator.Future<AdminUpdateDeviceStatusResult> adminUpdateDeviceStatusAsync(AdminUpdateDeviceStatusRequest adminUpdateDeviceStatusRequest, AsyncHandler<AdminUpdateDeviceStatusRequest,AdminUpdateDeviceStatusResult> asyncHandler)
Updates the device status as an administrator.
Requires developer credentials.
adminUpdateDeviceStatusRequest - The request to update the device status, as an administrator.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<AdminUpdateUserAttributesResult> adminUpdateUserAttributesAsync(AdminUpdateUserAttributesRequest adminUpdateUserAttributesRequest)
Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.
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.
adminUpdateUserAttributesRequest - Represents the request to update the user's attributes as an administrator.Future<AdminUpdateUserAttributesResult> adminUpdateUserAttributesAsync(AdminUpdateUserAttributesRequest adminUpdateUserAttributesRequest, AsyncHandler<AdminUpdateUserAttributesRequest,AdminUpdateUserAttributesResult> asyncHandler)
Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.
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.
adminUpdateUserAttributesRequest - Represents the request to update the user's attributes as an administrator.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<AdminUserGlobalSignOutResult> adminUserGlobalSignOutAsync(AdminUserGlobalSignOutRequest adminUserGlobalSignOutRequest)
Signs out users from all devices, as an administrator.
Requires developer credentials.
adminUserGlobalSignOutRequest - The request to sign out of all devices, as an administrator.Future<AdminUserGlobalSignOutResult> adminUserGlobalSignOutAsync(AdminUserGlobalSignOutRequest adminUserGlobalSignOutRequest, AsyncHandler<AdminUserGlobalSignOutRequest,AdminUserGlobalSignOutResult> asyncHandler)
Signs out users from all devices, as an administrator.
Requires developer credentials.
adminUserGlobalSignOutRequest - The request to sign out of all devices, as an administrator.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ChangePasswordResult> changePasswordAsync(ChangePasswordRequest changePasswordRequest)
Changes the password for a specified user in a user pool.
changePasswordRequest - Represents the request to change a user password.Future<ChangePasswordResult> changePasswordAsync(ChangePasswordRequest changePasswordRequest, AsyncHandler<ChangePasswordRequest,ChangePasswordResult> asyncHandler)
Changes the password for a specified user in a user pool.
changePasswordRequest - Represents the request to change a user password.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ConfirmDeviceResult> confirmDeviceAsync(ConfirmDeviceRequest confirmDeviceRequest)
Confirms tracking of the device. This API call is the call that begins device tracking.
confirmDeviceRequest - Confirms the device request.Future<ConfirmDeviceResult> confirmDeviceAsync(ConfirmDeviceRequest confirmDeviceRequest, AsyncHandler<ConfirmDeviceRequest,ConfirmDeviceResult> asyncHandler)
Confirms tracking of the device. This API call is the call that begins device tracking.
confirmDeviceRequest - Confirms the device request.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ConfirmForgotPasswordResult> confirmForgotPasswordAsync(ConfirmForgotPasswordRequest confirmForgotPasswordRequest)
Allows a user to enter a confirmation code to reset a forgotten password.
confirmForgotPasswordRequest - The request representing the confirmation for a password reset.Future<ConfirmForgotPasswordResult> confirmForgotPasswordAsync(ConfirmForgotPasswordRequest confirmForgotPasswordRequest, AsyncHandler<ConfirmForgotPasswordRequest,ConfirmForgotPasswordResult> asyncHandler)
Allows a user to enter a confirmation code to reset a forgotten password.
confirmForgotPasswordRequest - The request representing the confirmation for a password reset.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ConfirmSignUpResult> confirmSignUpAsync(ConfirmSignUpRequest confirmSignUpRequest)
Confirms registration of a user and handles the existing alias from a previous user.
confirmSignUpRequest - Represents the request to confirm registration of a user.Future<ConfirmSignUpResult> confirmSignUpAsync(ConfirmSignUpRequest confirmSignUpRequest, AsyncHandler<ConfirmSignUpRequest,ConfirmSignUpResult> asyncHandler)
Confirms registration of a user and handles the existing alias from a previous user.
confirmSignUpRequest - Represents the request to confirm registration of a user.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateGroupResult> createGroupAsync(CreateGroupRequest createGroupRequest)
Creates a new group in the specified user pool.
Requires developer credentials.
createGroupRequest - Future<CreateGroupResult> createGroupAsync(CreateGroupRequest createGroupRequest, AsyncHandler<CreateGroupRequest,CreateGroupResult> asyncHandler)
Creates a new group in the specified user pool.
Requires developer credentials.
createGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateIdentityProviderResult> createIdentityProviderAsync(CreateIdentityProviderRequest createIdentityProviderRequest)
Creates an identity provider for a user pool.
createIdentityProviderRequest - Future<CreateIdentityProviderResult> createIdentityProviderAsync(CreateIdentityProviderRequest createIdentityProviderRequest, AsyncHandler<CreateIdentityProviderRequest,CreateIdentityProviderResult> asyncHandler)
Creates an identity provider for a user pool.
createIdentityProviderRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateResourceServerResult> createResourceServerAsync(CreateResourceServerRequest createResourceServerRequest)
Creates a new OAuth2.0 resource server and defines custom scopes in it.
createResourceServerRequest - Future<CreateResourceServerResult> createResourceServerAsync(CreateResourceServerRequest createResourceServerRequest, AsyncHandler<CreateResourceServerRequest,CreateResourceServerResult> asyncHandler)
Creates a new OAuth2.0 resource server and defines custom scopes in it.
createResourceServerRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateUserImportJobResult> createUserImportJobAsync(CreateUserImportJobRequest createUserImportJobRequest)
Creates the user import job.
createUserImportJobRequest - Represents the request to create the user import job.Future<CreateUserImportJobResult> createUserImportJobAsync(CreateUserImportJobRequest createUserImportJobRequest, AsyncHandler<CreateUserImportJobRequest,CreateUserImportJobResult> asyncHandler)
Creates the user import job.
createUserImportJobRequest - Represents the request to create the user import job.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateUserPoolResult> createUserPoolAsync(CreateUserPoolRequest createUserPoolRequest)
Creates a new Amazon Cognito user pool and sets the password policy for the pool.
createUserPoolRequest - Represents the request to create a user pool.Future<CreateUserPoolResult> createUserPoolAsync(CreateUserPoolRequest createUserPoolRequest, AsyncHandler<CreateUserPoolRequest,CreateUserPoolResult> asyncHandler)
Creates a new Amazon Cognito user pool and sets the password policy for the pool.
createUserPoolRequest - Represents the request to create a user pool.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateUserPoolClientResult> createUserPoolClientAsync(CreateUserPoolClientRequest createUserPoolClientRequest)
Creates the user pool client.
createUserPoolClientRequest - Represents the request to create a user pool client.Future<CreateUserPoolClientResult> createUserPoolClientAsync(CreateUserPoolClientRequest createUserPoolClientRequest, AsyncHandler<CreateUserPoolClientRequest,CreateUserPoolClientResult> asyncHandler)
Creates the user pool client.
createUserPoolClientRequest - Represents the request to create a user pool client.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateUserPoolDomainResult> createUserPoolDomainAsync(CreateUserPoolDomainRequest createUserPoolDomainRequest)
Creates a new domain for a user pool.
createUserPoolDomainRequest - Future<CreateUserPoolDomainResult> createUserPoolDomainAsync(CreateUserPoolDomainRequest createUserPoolDomainRequest, AsyncHandler<CreateUserPoolDomainRequest,CreateUserPoolDomainResult> asyncHandler)
Creates a new domain for a user pool.
createUserPoolDomainRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest deleteGroupRequest)
Deletes a group. Currently only groups with no members can be deleted.
Requires developer credentials.
deleteGroupRequest - Future<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest deleteGroupRequest, AsyncHandler<DeleteGroupRequest,DeleteGroupResult> asyncHandler)
Deletes a group. Currently only groups with no members can be deleted.
Requires developer credentials.
deleteGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteIdentityProviderResult> deleteIdentityProviderAsync(DeleteIdentityProviderRequest deleteIdentityProviderRequest)
Deletes an identity provider for a user pool.
deleteIdentityProviderRequest - Future<DeleteIdentityProviderResult> deleteIdentityProviderAsync(DeleteIdentityProviderRequest deleteIdentityProviderRequest, AsyncHandler<DeleteIdentityProviderRequest,DeleteIdentityProviderResult> asyncHandler)
Deletes an identity provider for a user pool.
deleteIdentityProviderRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteResourceServerResult> deleteResourceServerAsync(DeleteResourceServerRequest deleteResourceServerRequest)
Deletes a resource server.
deleteResourceServerRequest - Future<DeleteResourceServerResult> deleteResourceServerAsync(DeleteResourceServerRequest deleteResourceServerRequest, AsyncHandler<DeleteResourceServerRequest,DeleteResourceServerResult> asyncHandler)
Deletes a resource server.
deleteResourceServerRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest deleteUserRequest)
Allows a user to delete himself or herself.
deleteUserRequest - Represents the request to delete a user.Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest deleteUserRequest, AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)
Allows a user to delete himself or herself.
deleteUserRequest - Represents the request to delete a user.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteUserAttributesResult> deleteUserAttributesAsync(DeleteUserAttributesRequest deleteUserAttributesRequest)
Deletes the attributes for a user.
deleteUserAttributesRequest - Represents the request to delete user attributes.Future<DeleteUserAttributesResult> deleteUserAttributesAsync(DeleteUserAttributesRequest deleteUserAttributesRequest, AsyncHandler<DeleteUserAttributesRequest,DeleteUserAttributesResult> asyncHandler)
Deletes the attributes for a user.
deleteUserAttributesRequest - Represents the request to delete user attributes.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteUserPoolResult> deleteUserPoolAsync(DeleteUserPoolRequest deleteUserPoolRequest)
Deletes the specified Amazon Cognito user pool.
deleteUserPoolRequest - Represents the request to delete a user pool.Future<DeleteUserPoolResult> deleteUserPoolAsync(DeleteUserPoolRequest deleteUserPoolRequest, AsyncHandler<DeleteUserPoolRequest,DeleteUserPoolResult> asyncHandler)
Deletes the specified Amazon Cognito user pool.
deleteUserPoolRequest - Represents the request to delete a user pool.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteUserPoolClientResult> deleteUserPoolClientAsync(DeleteUserPoolClientRequest deleteUserPoolClientRequest)
Allows the developer to delete the user pool client.
deleteUserPoolClientRequest - Represents the request to delete a user pool client.Future<DeleteUserPoolClientResult> deleteUserPoolClientAsync(DeleteUserPoolClientRequest deleteUserPoolClientRequest, AsyncHandler<DeleteUserPoolClientRequest,DeleteUserPoolClientResult> asyncHandler)
Allows the developer to delete the user pool client.
deleteUserPoolClientRequest - Represents the request to delete a user pool client.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteUserPoolDomainResult> deleteUserPoolDomainAsync(DeleteUserPoolDomainRequest deleteUserPoolDomainRequest)
Deletes a domain for a user pool.
deleteUserPoolDomainRequest - Future<DeleteUserPoolDomainResult> deleteUserPoolDomainAsync(DeleteUserPoolDomainRequest deleteUserPoolDomainRequest, AsyncHandler<DeleteUserPoolDomainRequest,DeleteUserPoolDomainResult> asyncHandler)
Deletes a domain for a user pool.
deleteUserPoolDomainRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeIdentityProviderResult> describeIdentityProviderAsync(DescribeIdentityProviderRequest describeIdentityProviderRequest)
Gets information about a specific identity provider.
describeIdentityProviderRequest - Future<DescribeIdentityProviderResult> describeIdentityProviderAsync(DescribeIdentityProviderRequest describeIdentityProviderRequest, AsyncHandler<DescribeIdentityProviderRequest,DescribeIdentityProviderResult> asyncHandler)
Gets information about a specific identity provider.
describeIdentityProviderRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeResourceServerResult> describeResourceServerAsync(DescribeResourceServerRequest describeResourceServerRequest)
Describes a resource server.
describeResourceServerRequest - Future<DescribeResourceServerResult> describeResourceServerAsync(DescribeResourceServerRequest describeResourceServerRequest, AsyncHandler<DescribeResourceServerRequest,DescribeResourceServerResult> asyncHandler)
Describes a resource server.
describeResourceServerRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeUserImportJobResult> describeUserImportJobAsync(DescribeUserImportJobRequest describeUserImportJobRequest)
Describes the user import job.
describeUserImportJobRequest - Represents the request to describe the user import job.Future<DescribeUserImportJobResult> describeUserImportJobAsync(DescribeUserImportJobRequest describeUserImportJobRequest, AsyncHandler<DescribeUserImportJobRequest,DescribeUserImportJobResult> asyncHandler)
Describes the user import job.
describeUserImportJobRequest - Represents the request to describe the user import job.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeUserPoolResult> describeUserPoolAsync(DescribeUserPoolRequest describeUserPoolRequest)
Returns the configuration information and metadata of the specified user pool.
describeUserPoolRequest - Represents the request to describe the user pool.Future<DescribeUserPoolResult> describeUserPoolAsync(DescribeUserPoolRequest describeUserPoolRequest, AsyncHandler<DescribeUserPoolRequest,DescribeUserPoolResult> asyncHandler)
Returns the configuration information and metadata of the specified user pool.
describeUserPoolRequest - Represents the request to describe the user pool.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeUserPoolClientResult> describeUserPoolClientAsync(DescribeUserPoolClientRequest describeUserPoolClientRequest)
Client method for returning the configuration information and metadata of the specified user pool client.
describeUserPoolClientRequest - Represents the request to describe a user pool client.Future<DescribeUserPoolClientResult> describeUserPoolClientAsync(DescribeUserPoolClientRequest describeUserPoolClientRequest, AsyncHandler<DescribeUserPoolClientRequest,DescribeUserPoolClientResult> asyncHandler)
Client method for returning the configuration information and metadata of the specified user pool client.
describeUserPoolClientRequest - Represents the request to describe a user pool client.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeUserPoolDomainResult> describeUserPoolDomainAsync(DescribeUserPoolDomainRequest describeUserPoolDomainRequest)
Gets information about a domain.
describeUserPoolDomainRequest - Future<DescribeUserPoolDomainResult> describeUserPoolDomainAsync(DescribeUserPoolDomainRequest describeUserPoolDomainRequest, AsyncHandler<DescribeUserPoolDomainRequest,DescribeUserPoolDomainResult> asyncHandler)
Gets information about a domain.
describeUserPoolDomainRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ForgetDeviceResult> forgetDeviceAsync(ForgetDeviceRequest forgetDeviceRequest)
Forgets the specified device.
forgetDeviceRequest - Represents the request to forget the device.Future<ForgetDeviceResult> forgetDeviceAsync(ForgetDeviceRequest forgetDeviceRequest, AsyncHandler<ForgetDeviceRequest,ForgetDeviceResult> asyncHandler)
Forgets the specified device.
forgetDeviceRequest - Represents the request to forget the device.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ForgotPasswordResult> forgotPasswordAsync(ForgotPasswordRequest forgotPasswordRequest)
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.
forgotPasswordRequest - Represents the request to reset a user's password.Future<ForgotPasswordResult> forgotPasswordAsync(ForgotPasswordRequest forgotPasswordRequest, AsyncHandler<ForgotPasswordRequest,ForgotPasswordResult> asyncHandler)
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.
forgotPasswordRequest - Represents the request to reset a user's password.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetCSVHeaderResult> getCSVHeaderAsync(GetCSVHeaderRequest getCSVHeaderRequest)
Gets the header information for the .csv file to be used as input for the user import job.
getCSVHeaderRequest - Represents the request to get the header information for the .csv file for the user import job.Future<GetCSVHeaderResult> getCSVHeaderAsync(GetCSVHeaderRequest getCSVHeaderRequest, AsyncHandler<GetCSVHeaderRequest,GetCSVHeaderResult> asyncHandler)
Gets the header information for the .csv file to be used as input for the user import job.
getCSVHeaderRequest - Represents the request to get the header information for the .csv file for the user import job.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetDeviceResult> getDeviceAsync(GetDeviceRequest getDeviceRequest)
Gets the device.
getDeviceRequest - Represents the request to get the device.Future<GetDeviceResult> getDeviceAsync(GetDeviceRequest getDeviceRequest, AsyncHandler<GetDeviceRequest,GetDeviceResult> asyncHandler)
Gets the device.
getDeviceRequest - Represents the request to get the device.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetGroupResult> getGroupAsync(GetGroupRequest getGroupRequest)
Gets a group.
Requires developer credentials.
getGroupRequest - Future<GetGroupResult> getGroupAsync(GetGroupRequest getGroupRequest, AsyncHandler<GetGroupRequest,GetGroupResult> asyncHandler)
Gets a group.
Requires developer credentials.
getGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetIdentityProviderByIdentifierResult> getIdentityProviderByIdentifierAsync(GetIdentityProviderByIdentifierRequest getIdentityProviderByIdentifierRequest)
Gets the specified identity provider.
getIdentityProviderByIdentifierRequest - Future<GetIdentityProviderByIdentifierResult> getIdentityProviderByIdentifierAsync(GetIdentityProviderByIdentifierRequest getIdentityProviderByIdentifierRequest, AsyncHandler<GetIdentityProviderByIdentifierRequest,GetIdentityProviderByIdentifierResult> asyncHandler)
Gets the specified identity provider.
getIdentityProviderByIdentifierRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetUICustomizationResult> getUICustomizationAsync(GetUICustomizationRequest getUICustomizationRequest)
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.
getUICustomizationRequest - Future<GetUICustomizationResult> getUICustomizationAsync(GetUICustomizationRequest getUICustomizationRequest, AsyncHandler<GetUICustomizationRequest,GetUICustomizationResult> asyncHandler)
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.
getUICustomizationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetUserResult> getUserAsync(GetUserRequest getUserRequest)
Gets the user attributes and metadata for a user.
getUserRequest - Represents the request to get information about the user.Future<GetUserResult> getUserAsync(GetUserRequest getUserRequest, AsyncHandler<GetUserRequest,GetUserResult> asyncHandler)
Gets the user attributes and metadata for a user.
getUserRequest - Represents the request to get information about the user.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetUserAttributeVerificationCodeResult> getUserAttributeVerificationCodeAsync(GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest)
Gets the user attribute verification code for the specified attribute name.
getUserAttributeVerificationCodeRequest - Represents the request to get user attribute verification.Future<GetUserAttributeVerificationCodeResult> getUserAttributeVerificationCodeAsync(GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest, AsyncHandler<GetUserAttributeVerificationCodeRequest,GetUserAttributeVerificationCodeResult> asyncHandler)
Gets the user attribute verification code for the specified attribute name.
getUserAttributeVerificationCodeRequest - Represents the request to get user attribute verification.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GlobalSignOutResult> globalSignOutAsync(GlobalSignOutRequest globalSignOutRequest)
Signs out users from all devices.
globalSignOutRequest - Represents the request to sign out all devices.Future<GlobalSignOutResult> globalSignOutAsync(GlobalSignOutRequest globalSignOutRequest, AsyncHandler<GlobalSignOutRequest,GlobalSignOutResult> asyncHandler)
Signs out users from all devices.
globalSignOutRequest - Represents the request to sign out all devices.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<InitiateAuthResult> initiateAuthAsync(InitiateAuthRequest initiateAuthRequest)
Initiates the authentication flow.
initiateAuthRequest - Initiates the authentication request.Future<InitiateAuthResult> initiateAuthAsync(InitiateAuthRequest initiateAuthRequest, AsyncHandler<InitiateAuthRequest,InitiateAuthResult> asyncHandler)
Initiates the authentication flow.
initiateAuthRequest - Initiates the authentication request.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListDevicesResult> listDevicesAsync(ListDevicesRequest listDevicesRequest)
Lists the devices.
listDevicesRequest - Represents the request to list the devices.Future<ListDevicesResult> listDevicesAsync(ListDevicesRequest listDevicesRequest, AsyncHandler<ListDevicesRequest,ListDevicesResult> asyncHandler)
Lists the devices.
listDevicesRequest - Represents the request to list the devices.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListGroupsResult> listGroupsAsync(ListGroupsRequest listGroupsRequest)
Lists the groups associated with a user pool.
Requires developer credentials.
listGroupsRequest - Future<ListGroupsResult> listGroupsAsync(ListGroupsRequest listGroupsRequest, AsyncHandler<ListGroupsRequest,ListGroupsResult> asyncHandler)
Lists the groups associated with a user pool.
Requires developer credentials.
listGroupsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListIdentityProvidersResult> listIdentityProvidersAsync(ListIdentityProvidersRequest listIdentityProvidersRequest)
Lists information about all identity providers for a user pool.
listIdentityProvidersRequest - Future<ListIdentityProvidersResult> listIdentityProvidersAsync(ListIdentityProvidersRequest listIdentityProvidersRequest, AsyncHandler<ListIdentityProvidersRequest,ListIdentityProvidersResult> asyncHandler)
Lists information about all identity providers for a user pool.
listIdentityProvidersRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListResourceServersResult> listResourceServersAsync(ListResourceServersRequest listResourceServersRequest)
Lists the resource servers for a user pool.
listResourceServersRequest - Future<ListResourceServersResult> listResourceServersAsync(ListResourceServersRequest listResourceServersRequest, AsyncHandler<ListResourceServersRequest,ListResourceServersResult> asyncHandler)
Lists the resource servers for a user pool.
listResourceServersRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListUserImportJobsResult> listUserImportJobsAsync(ListUserImportJobsRequest listUserImportJobsRequest)
Lists the user import jobs.
listUserImportJobsRequest - Represents the request to list the user import jobs.Future<ListUserImportJobsResult> listUserImportJobsAsync(ListUserImportJobsRequest listUserImportJobsRequest, AsyncHandler<ListUserImportJobsRequest,ListUserImportJobsResult> asyncHandler)
Lists the user import jobs.
listUserImportJobsRequest - Represents the request to list the user import jobs.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListUserPoolClientsResult> listUserPoolClientsAsync(ListUserPoolClientsRequest listUserPoolClientsRequest)
Lists the clients that have been created for the specified user pool.
listUserPoolClientsRequest - Represents the request to list the user pool clients.Future<ListUserPoolClientsResult> listUserPoolClientsAsync(ListUserPoolClientsRequest listUserPoolClientsRequest, AsyncHandler<ListUserPoolClientsRequest,ListUserPoolClientsResult> asyncHandler)
Lists the clients that have been created for the specified user pool.
listUserPoolClientsRequest - Represents the request to list the user pool clients.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListUserPoolsResult> listUserPoolsAsync(ListUserPoolsRequest listUserPoolsRequest)
Lists the user pools associated with an AWS account.
listUserPoolsRequest - Represents the request to list user pools.Future<ListUserPoolsResult> listUserPoolsAsync(ListUserPoolsRequest listUserPoolsRequest, AsyncHandler<ListUserPoolsRequest,ListUserPoolsResult> asyncHandler)
Lists the user pools associated with an AWS account.
listUserPoolsRequest - Represents the request to list user pools.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListUsersResult> listUsersAsync(ListUsersRequest listUsersRequest)
Lists the users in the Amazon Cognito user pool.
listUsersRequest - Represents the request to list users.Future<ListUsersResult> listUsersAsync(ListUsersRequest listUsersRequest, AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler)
Lists the users in the Amazon Cognito user pool.
listUsersRequest - Represents the request to list users.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListUsersInGroupResult> listUsersInGroupAsync(ListUsersInGroupRequest listUsersInGroupRequest)
Lists the users in the specified group.
Requires developer credentials.
listUsersInGroupRequest - Future<ListUsersInGroupResult> listUsersInGroupAsync(ListUsersInGroupRequest listUsersInGroupRequest, AsyncHandler<ListUsersInGroupRequest,ListUsersInGroupResult> asyncHandler)
Lists the users in the specified group.
Requires developer credentials.
listUsersInGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ResendConfirmationCodeResult> resendConfirmationCodeAsync(ResendConfirmationCodeRequest resendConfirmationCodeRequest)
Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
resendConfirmationCodeRequest - Represents the request to resend the confirmation code.Future<ResendConfirmationCodeResult> resendConfirmationCodeAsync(ResendConfirmationCodeRequest resendConfirmationCodeRequest, AsyncHandler<ResendConfirmationCodeRequest,ResendConfirmationCodeResult> asyncHandler)
Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
resendConfirmationCodeRequest - Represents the request to resend the confirmation code.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RespondToAuthChallengeResult> respondToAuthChallengeAsync(RespondToAuthChallengeRequest respondToAuthChallengeRequest)
Responds to the authentication challenge.
respondToAuthChallengeRequest - The request to respond to an authentication challenge.Future<RespondToAuthChallengeResult> respondToAuthChallengeAsync(RespondToAuthChallengeRequest respondToAuthChallengeRequest, AsyncHandler<RespondToAuthChallengeRequest,RespondToAuthChallengeResult> asyncHandler)
Responds to the authentication challenge.
respondToAuthChallengeRequest - The request to respond to an authentication challenge.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<SetUICustomizationResult> setUICustomizationAsync(SetUICustomizationRequest setUICustomizationRequest)
Sets 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.
setUICustomizationRequest - Future<SetUICustomizationResult> setUICustomizationAsync(SetUICustomizationRequest setUICustomizationRequest, AsyncHandler<SetUICustomizationRequest,SetUICustomizationResult> asyncHandler)
Sets 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.
setUICustomizationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<SetUserSettingsResult> setUserSettingsAsync(SetUserSettingsRequest setUserSettingsRequest)
Sets the user settings like multi-factor authentication (MFA). If MFA is to be removed for a particular attribute pass the attribute with code delivery as null. If null list is passed, all MFA options are removed.
setUserSettingsRequest - Represents the request to set user settings.Future<SetUserSettingsResult> setUserSettingsAsync(SetUserSettingsRequest setUserSettingsRequest, AsyncHandler<SetUserSettingsRequest,SetUserSettingsResult> asyncHandler)
Sets the user settings like multi-factor authentication (MFA). If MFA is to be removed for a particular attribute pass the attribute with code delivery as null. If null list is passed, all MFA options are removed.
setUserSettingsRequest - Represents the request to set user settings.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<SignUpResult> signUpAsync(SignUpRequest signUpRequest)
Registers the user in the specified user pool and creates a user name, password, and user attributes.
signUpRequest - Represents the request to register a user.Future<SignUpResult> signUpAsync(SignUpRequest signUpRequest, AsyncHandler<SignUpRequest,SignUpResult> asyncHandler)
Registers the user in the specified user pool and creates a user name, password, and user attributes.
signUpRequest - Represents the request to register a user.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartUserImportJobResult> startUserImportJobAsync(StartUserImportJobRequest startUserImportJobRequest)
Starts the user import.
startUserImportJobRequest - Represents the request to start the user import job.Future<StartUserImportJobResult> startUserImportJobAsync(StartUserImportJobRequest startUserImportJobRequest, AsyncHandler<StartUserImportJobRequest,StartUserImportJobResult> asyncHandler)
Starts the user import.
startUserImportJobRequest - Represents the request to start the user import job.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StopUserImportJobResult> stopUserImportJobAsync(StopUserImportJobRequest stopUserImportJobRequest)
Stops the user import job.
stopUserImportJobRequest - Represents the request to stop the user import job.Future<StopUserImportJobResult> stopUserImportJobAsync(StopUserImportJobRequest stopUserImportJobRequest, AsyncHandler<StopUserImportJobRequest,StopUserImportJobResult> asyncHandler)
Stops the user import job.
stopUserImportJobRequest - Represents the request to stop the user import job.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateDeviceStatusResult> updateDeviceStatusAsync(UpdateDeviceStatusRequest updateDeviceStatusRequest)
Updates the device status.
updateDeviceStatusRequest - Represents the request to update the device status.Future<UpdateDeviceStatusResult> updateDeviceStatusAsync(UpdateDeviceStatusRequest updateDeviceStatusRequest, AsyncHandler<UpdateDeviceStatusRequest,UpdateDeviceStatusResult> asyncHandler)
Updates the device status.
updateDeviceStatusRequest - Represents the request to update the device status.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateGroupResult> updateGroupAsync(UpdateGroupRequest updateGroupRequest)
Updates the specified group with the specified attributes.
Requires developer credentials.
updateGroupRequest - Future<UpdateGroupResult> updateGroupAsync(UpdateGroupRequest updateGroupRequest, AsyncHandler<UpdateGroupRequest,UpdateGroupResult> asyncHandler)
Updates the specified group with the specified attributes.
Requires developer credentials.
updateGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateIdentityProviderResult> updateIdentityProviderAsync(UpdateIdentityProviderRequest updateIdentityProviderRequest)
Updates identity provider information for a user pool.
updateIdentityProviderRequest - Future<UpdateIdentityProviderResult> updateIdentityProviderAsync(UpdateIdentityProviderRequest updateIdentityProviderRequest, AsyncHandler<UpdateIdentityProviderRequest,UpdateIdentityProviderResult> asyncHandler)
Updates identity provider information for a user pool.
updateIdentityProviderRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateResourceServerResult> updateResourceServerAsync(UpdateResourceServerRequest updateResourceServerRequest)
Updates the name and scopes of resource server. All other fields are read-only.
updateResourceServerRequest - Future<UpdateResourceServerResult> updateResourceServerAsync(UpdateResourceServerRequest updateResourceServerRequest, AsyncHandler<UpdateResourceServerRequest,UpdateResourceServerResult> asyncHandler)
Updates the name and scopes of resource server. All other fields are read-only.
updateResourceServerRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateUserAttributesResult> updateUserAttributesAsync(UpdateUserAttributesRequest updateUserAttributesRequest)
Allows a user to update a specific attribute (one at a time).
updateUserAttributesRequest - Represents the request to update user attributes.Future<UpdateUserAttributesResult> updateUserAttributesAsync(UpdateUserAttributesRequest updateUserAttributesRequest, AsyncHandler<UpdateUserAttributesRequest,UpdateUserAttributesResult> asyncHandler)
Allows a user to update a specific attribute (one at a time).
updateUserAttributesRequest - Represents the request to update user attributes.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateUserPoolResult> updateUserPoolAsync(UpdateUserPoolRequest updateUserPoolRequest)
Updates the specified user pool with the specified attributes.
updateUserPoolRequest - Represents the request to update the user pool.Future<UpdateUserPoolResult> updateUserPoolAsync(UpdateUserPoolRequest updateUserPoolRequest, AsyncHandler<UpdateUserPoolRequest,UpdateUserPoolResult> asyncHandler)
Updates the specified user pool with the specified attributes.
updateUserPoolRequest - Represents the request to update the user pool.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateUserPoolClientResult> updateUserPoolClientAsync(UpdateUserPoolClientRequest updateUserPoolClientRequest)
Allows the developer to update the specified user pool client and password policy.
updateUserPoolClientRequest - Represents the request to update the user pool client.Future<UpdateUserPoolClientResult> updateUserPoolClientAsync(UpdateUserPoolClientRequest updateUserPoolClientRequest, AsyncHandler<UpdateUserPoolClientRequest,UpdateUserPoolClientResult> asyncHandler)
Allows the developer to update the specified user pool client and password policy.
updateUserPoolClientRequest - Represents the request to update the user pool client.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<VerifyUserAttributeResult> verifyUserAttributeAsync(VerifyUserAttributeRequest verifyUserAttributeRequest)
Verifies the specified user attributes in the user pool.
verifyUserAttributeRequest - Represents the request to verify user attributes.Future<VerifyUserAttributeResult> verifyUserAttributeAsync(VerifyUserAttributeRequest verifyUserAttributeRequest, AsyncHandler<VerifyUserAttributeRequest,VerifyUserAttributeResult> asyncHandler)
Verifies the specified user attributes in the user pool.
verifyUserAttributeRequest - Represents the request to verify user attributes.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.