AutoCloseable
@Generated("software.amazon.awssdk:codegen") public interface CognitoIdentityProviderAsyncClient extends AutoCloseable
builder()
method.
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.
Modifier and Type | Method | Description |
---|---|---|
default CompletableFuture<AddCustomAttributesResponse> |
addCustomAttributes(AddCustomAttributesRequest addCustomAttributesRequest) |
Adds additional user attributes to the user pool schema.
|
default CompletableFuture<AdminAddUserToGroupResponse> |
adminAddUserToGroup(AdminAddUserToGroupRequest adminAddUserToGroupRequest) |
Adds the specified user to the specified group.
|
default CompletableFuture<AdminConfirmSignUpResponse> |
adminConfirmSignUp(AdminConfirmSignUpRequest adminConfirmSignUpRequest) |
Confirms user registration as an admin without using a confirmation code.
|
default CompletableFuture<AdminCreateUserResponse> |
adminCreateUser(AdminCreateUserRequest adminCreateUserRequest) |
Creates a new user in the specified user pool and sends a welcome message via email or phone (SMS).
|
default CompletableFuture<AdminDeleteUserResponse> |
adminDeleteUser(AdminDeleteUserRequest adminDeleteUserRequest) |
Deletes a user as an administrator.
|
default CompletableFuture<AdminDeleteUserAttributesResponse> |
adminDeleteUserAttributes(AdminDeleteUserAttributesRequest adminDeleteUserAttributesRequest) |
Deletes the user attributes in a user pool as an administrator.
|
default CompletableFuture<AdminDisableUserResponse> |
adminDisableUser(AdminDisableUserRequest adminDisableUserRequest) |
Disables the specified user as an administrator.
|
default CompletableFuture<AdminEnableUserResponse> |
adminEnableUser(AdminEnableUserRequest adminEnableUserRequest) |
Enables the specified user as an administrator.
|
default CompletableFuture<AdminForgetDeviceResponse> |
adminForgetDevice(AdminForgetDeviceRequest adminForgetDeviceRequest) |
Forgets the device, as an administrator.
|
default CompletableFuture<AdminGetDeviceResponse> |
adminGetDevice(AdminGetDeviceRequest adminGetDeviceRequest) |
Gets the device, as an administrator.
|
default CompletableFuture<AdminGetUserResponse> |
adminGetUser(AdminGetUserRequest adminGetUserRequest) |
Gets the specified user by user name in a user pool as an administrator.
|
default CompletableFuture<AdminInitiateAuthResponse> |
adminInitiateAuth(AdminInitiateAuthRequest adminInitiateAuthRequest) |
Initiates the authentication flow, as an administrator.
|
default CompletableFuture<AdminListDevicesResponse> |
adminListDevices(AdminListDevicesRequest adminListDevicesRequest) |
Lists devices, as an administrator.
|
default CompletableFuture<AdminListGroupsForUserResponse> |
adminListGroupsForUser(AdminListGroupsForUserRequest adminListGroupsForUserRequest) |
Lists the groups that the user belongs to.
|
default CompletableFuture<AdminRemoveUserFromGroupResponse> |
adminRemoveUserFromGroup(AdminRemoveUserFromGroupRequest adminRemoveUserFromGroupRequest) |
Removes the specified user from the specified group.
|
default CompletableFuture<AdminResetUserPasswordResponse> |
adminResetUserPassword(AdminResetUserPasswordRequest adminResetUserPasswordRequest) |
Resets the specified user's password in a user pool as an administrator.
|
default CompletableFuture<AdminRespondToAuthChallengeResponse> |
adminRespondToAuthChallenge(AdminRespondToAuthChallengeRequest adminRespondToAuthChallengeRequest) |
Responds to an authentication challenge, as an administrator.
|
default CompletableFuture<AdminSetUserSettingsResponse> |
adminSetUserSettings(AdminSetUserSettingsRequest adminSetUserSettingsRequest) |
Sets all the user settings for a specified user name.
|
default CompletableFuture<AdminUpdateDeviceStatusResponse> |
adminUpdateDeviceStatus(AdminUpdateDeviceStatusRequest adminUpdateDeviceStatusRequest) |
Updates the device status as an administrator.
|
default CompletableFuture<AdminUpdateUserAttributesResponse> |
adminUpdateUserAttributes(AdminUpdateUserAttributesRequest adminUpdateUserAttributesRequest) |
Updates the specified user's attributes, including developer attributes, as an administrator.
|
default CompletableFuture<AdminUserGlobalSignOutResponse> |
adminUserGlobalSignOut(AdminUserGlobalSignOutRequest adminUserGlobalSignOutRequest) |
Signs out users from all devices, as an administrator.
|
static CognitoIdentityProviderAsyncClientBuilder |
builder() |
Create a builder that can be used to configure and create a
CognitoIdentityProviderAsyncClient . |
default CompletableFuture<ChangePasswordResponse> |
changePassword(ChangePasswordRequest changePasswordRequest) |
Changes the password for a specified user in a user pool.
|
default CompletableFuture<ConfirmDeviceResponse> |
confirmDevice(ConfirmDeviceRequest confirmDeviceRequest) |
Confirms tracking of the device.
|
default CompletableFuture<ConfirmForgotPasswordResponse> |
confirmForgotPassword(ConfirmForgotPasswordRequest confirmForgotPasswordRequest) |
Allows a user to enter a confirmation code to reset a forgotten password.
|
default CompletableFuture<ConfirmSignUpResponse> |
confirmSignUp(ConfirmSignUpRequest confirmSignUpRequest) |
Confirms registration of a user and handles the existing alias from a previous user.
|
static CognitoIdentityProviderAsyncClient |
create() |
Create a
CognitoIdentityProviderAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CompletableFuture<CreateGroupResponse> |
createGroup(CreateGroupRequest createGroupRequest) |
Creates a new group in the specified user pool.
|
default CompletableFuture<CreateIdentityProviderResponse> |
createIdentityProvider(CreateIdentityProviderRequest createIdentityProviderRequest) |
Creates an identity provider for a user pool.
|
default CompletableFuture<CreateUserImportJobResponse> |
createUserImportJob(CreateUserImportJobRequest createUserImportJobRequest) |
Creates the user import job.
|
default CompletableFuture<CreateUserPoolResponse> |
createUserPool(CreateUserPoolRequest createUserPoolRequest) |
Creates a new Amazon Cognito user pool and sets the password policy for the pool.
|
default CompletableFuture<CreateUserPoolClientResponse> |
createUserPoolClient(CreateUserPoolClientRequest createUserPoolClientRequest) |
Creates the user pool client.
|
default CompletableFuture<CreateUserPoolDomainResponse> |
createUserPoolDomain(CreateUserPoolDomainRequest createUserPoolDomainRequest) |
Creates a new domain for a user pool.
|
default CompletableFuture<DeleteGroupResponse> |
deleteGroup(DeleteGroupRequest deleteGroupRequest) |
Deletes a group.
|
default CompletableFuture<DeleteIdentityProviderResponse> |
deleteIdentityProvider(DeleteIdentityProviderRequest deleteIdentityProviderRequest) |
Deletes an identity provider for a user pool.
|
default CompletableFuture<DeleteUserResponse> |
deleteUser(DeleteUserRequest deleteUserRequest) |
Allows a user to delete one's self.
|
default CompletableFuture<DeleteUserAttributesResponse> |
deleteUserAttributes(DeleteUserAttributesRequest deleteUserAttributesRequest) |
Deletes the attributes for a user.
|
default CompletableFuture<DeleteUserPoolResponse> |
deleteUserPool(DeleteUserPoolRequest deleteUserPoolRequest) |
Deletes the specified Amazon Cognito user pool.
|
default CompletableFuture<DeleteUserPoolClientResponse> |
deleteUserPoolClient(DeleteUserPoolClientRequest deleteUserPoolClientRequest) |
Allows the developer to delete the user pool client.
|
default CompletableFuture<DeleteUserPoolDomainResponse> |
deleteUserPoolDomain(DeleteUserPoolDomainRequest deleteUserPoolDomainRequest) |
Deletes a domain for a user pool.
|
default CompletableFuture<DescribeIdentityProviderResponse> |
describeIdentityProvider(DescribeIdentityProviderRequest describeIdentityProviderRequest) |
Gets information about a specific identity provider.
|
default CompletableFuture<DescribeUserImportJobResponse> |
describeUserImportJob(DescribeUserImportJobRequest describeUserImportJobRequest) |
Describes the user import job.
|
default CompletableFuture<DescribeUserPoolResponse> |
describeUserPool(DescribeUserPoolRequest describeUserPoolRequest) |
Returns the configuration information and metadata of the specified user pool.
|
default CompletableFuture<DescribeUserPoolClientResponse> |
describeUserPoolClient(DescribeUserPoolClientRequest describeUserPoolClientRequest) |
Client method for returning the configuration information and metadata of the specified user pool client.
|
default CompletableFuture<DescribeUserPoolDomainResponse> |
describeUserPoolDomain(DescribeUserPoolDomainRequest describeUserPoolDomainRequest) |
Gets information about a domain.
|
default CompletableFuture<ForgetDeviceResponse> |
forgetDevice(ForgetDeviceRequest forgetDeviceRequest) |
Forgets the specified device.
|
default CompletableFuture<ForgotPasswordResponse> |
forgotPassword(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.
|
default CompletableFuture<GetCSVHeaderResponse> |
getCSVHeader(GetCSVHeaderRequest getCSVHeaderRequest) |
Gets the header information for the .csv file to be used as input for the user import job.
|
default CompletableFuture<GetDeviceResponse> |
getDevice(GetDeviceRequest getDeviceRequest) |
Gets the device.
|
default CompletableFuture<GetGroupResponse> |
getGroup(GetGroupRequest getGroupRequest) |
Gets a group.
|
default CompletableFuture<GetIdentityProviderByIdentifierResponse> |
getIdentityProviderByIdentifier(GetIdentityProviderByIdentifierRequest getIdentityProviderByIdentifierRequest) |
Gets the specified identity provider.
|
default CompletableFuture<GetUserResponse> |
getUser(GetUserRequest getUserRequest) |
Gets the user attributes and metadata for a user.
|
default CompletableFuture<GetUserAttributeVerificationCodeResponse> |
getUserAttributeVerificationCode(GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest) |
Gets the user attribute verification code for the specified attribute name.
|
default CompletableFuture<GlobalSignOutResponse> |
globalSignOut(GlobalSignOutRequest globalSignOutRequest) |
Signs out users from all devices.
|
default CompletableFuture<InitiateAuthResponse> |
initiateAuth(InitiateAuthRequest initiateAuthRequest) |
Initiates the authentication flow.
|
default CompletableFuture<ListDevicesResponse> |
listDevices(ListDevicesRequest listDevicesRequest) |
Lists the devices.
|
default CompletableFuture<ListGroupsResponse> |
listGroups(ListGroupsRequest listGroupsRequest) |
Lists the groups associated with a user pool.
|
default CompletableFuture<ListIdentityProvidersResponse> |
listIdentityProviders(ListIdentityProvidersRequest listIdentityProvidersRequest) |
Lists information about all identity providers for a user pool.
|
default CompletableFuture<ListUserImportJobsResponse> |
listUserImportJobs(ListUserImportJobsRequest listUserImportJobsRequest) |
Lists the user import jobs.
|
default CompletableFuture<ListUserPoolClientsResponse> |
listUserPoolClients(ListUserPoolClientsRequest listUserPoolClientsRequest) |
Lists the clients that have been created for the specified user pool.
|
default CompletableFuture<ListUserPoolsResponse> |
listUserPools(ListUserPoolsRequest listUserPoolsRequest) |
Lists the user pools associated with an AWS account.
|
default CompletableFuture<ListUsersResponse> |
listUsers(ListUsersRequest listUsersRequest) |
Lists the users in the Amazon Cognito user pool.
|
default CompletableFuture<ListUsersInGroupResponse> |
listUsersInGroup(ListUsersInGroupRequest listUsersInGroupRequest) |
Lists the users in the specified group.
|
default CompletableFuture<ResendConfirmationCodeResponse> |
resendConfirmationCode(ResendConfirmationCodeRequest resendConfirmationCodeRequest) |
Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
|
default CompletableFuture<RespondToAuthChallengeResponse> |
respondToAuthChallenge(RespondToAuthChallengeRequest respondToAuthChallengeRequest) |
Responds to the authentication challenge.
|
default CompletableFuture<SetUserSettingsResponse> |
setUserSettings(SetUserSettingsRequest setUserSettingsRequest) |
Sets the user settings like multi-factor authentication (MFA).
|
default CompletableFuture<SignUpResponse> |
signUp(SignUpRequest signUpRequest) |
Registers the user in the specified user pool and creates a user name, password, and user attributes.
|
default CompletableFuture<StartUserImportJobResponse> |
startUserImportJob(StartUserImportJobRequest startUserImportJobRequest) |
Starts the user import.
|
default CompletableFuture<StopUserImportJobResponse> |
stopUserImportJob(StopUserImportJobRequest stopUserImportJobRequest) |
Stops the user import job.
|
default CompletableFuture<UpdateDeviceStatusResponse> |
updateDeviceStatus(UpdateDeviceStatusRequest updateDeviceStatusRequest) |
Updates the device status.
|
default CompletableFuture<UpdateGroupResponse> |
updateGroup(UpdateGroupRequest updateGroupRequest) |
Updates the specified group with the specified attributes.
|
default CompletableFuture<UpdateIdentityProviderResponse> |
updateIdentityProvider(UpdateIdentityProviderRequest updateIdentityProviderRequest) |
Updates identity provider information for a user pool.
|
default CompletableFuture<UpdateUserAttributesResponse> |
updateUserAttributes(UpdateUserAttributesRequest updateUserAttributesRequest) |
Allows a user to update a specific attribute (one at a time).
|
default CompletableFuture<UpdateUserPoolResponse> |
updateUserPool(UpdateUserPoolRequest updateUserPoolRequest) |
Updates the specified user pool with the specified attributes.
|
default CompletableFuture<UpdateUserPoolClientResponse> |
updateUserPoolClient(UpdateUserPoolClientRequest updateUserPoolClientRequest) |
Allows the developer to update the specified user pool client and password policy.
|
default CompletableFuture<VerifyUserAttributeResponse> |
verifyUserAttribute(VerifyUserAttributeRequest verifyUserAttributeRequest) |
Verifies the specified user attributes in the user pool.
|
close
static CognitoIdentityProviderAsyncClient create()
CognitoIdentityProviderAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static CognitoIdentityProviderAsyncClientBuilder builder()
CognitoIdentityProviderAsyncClient
.default CompletableFuture<AddCustomAttributesResponse> addCustomAttributes(AddCustomAttributesRequest addCustomAttributesRequest)
Adds additional user attributes to the user pool schema.
addCustomAttributesRequest
- Represents the request to add custom attributes.default CompletableFuture<AdminAddUserToGroupResponse> adminAddUserToGroup(AdminAddUserToGroupRequest adminAddUserToGroupRequest)
Adds the specified user to the specified group.
Requires developer credentials.
adminAddUserToGroupRequest
- default CompletableFuture<AdminConfirmSignUpResponse> adminConfirmSignUp(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.default CompletableFuture<AdminCreateUserResponse> adminCreateUser(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.default CompletableFuture<AdminDeleteUserResponse> adminDeleteUser(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.default CompletableFuture<AdminDeleteUserAttributesResponse> adminDeleteUserAttributes(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.default CompletableFuture<AdminDisableUserResponse> adminDisableUser(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.default CompletableFuture<AdminEnableUserResponse> adminEnableUser(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.default CompletableFuture<AdminForgetDeviceResponse> adminForgetDevice(AdminForgetDeviceRequest adminForgetDeviceRequest)
Forgets the device, as an administrator.
Requires developer credentials.
adminForgetDeviceRequest
- Sends the forgot device request, as an administrator.default CompletableFuture<AdminGetDeviceResponse> adminGetDevice(AdminGetDeviceRequest adminGetDeviceRequest)
Gets the device, as an administrator.
Requires developer credentials.
adminGetDeviceRequest
- Represents the request to get the device, as an administrator.default CompletableFuture<AdminGetUserResponse> adminGetUser(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.default CompletableFuture<AdminInitiateAuthResponse> adminInitiateAuth(AdminInitiateAuthRequest adminInitiateAuthRequest)
Initiates the authentication flow, as an administrator.
Requires developer credentials.
adminInitiateAuthRequest
- Initiates the authorization request, as an administrator.default CompletableFuture<AdminListDevicesResponse> adminListDevices(AdminListDevicesRequest adminListDevicesRequest)
Lists devices, as an administrator.
Requires developer credentials.
adminListDevicesRequest
- Represents the request to list devices, as an administrator.default CompletableFuture<AdminListGroupsForUserResponse> adminListGroupsForUser(AdminListGroupsForUserRequest adminListGroupsForUserRequest)
Lists the groups that the user belongs to.
Requires developer credentials.
adminListGroupsForUserRequest
- default CompletableFuture<AdminRemoveUserFromGroupResponse> adminRemoveUserFromGroup(AdminRemoveUserFromGroupRequest adminRemoveUserFromGroupRequest)
Removes the specified user from the specified group.
Requires developer credentials.
adminRemoveUserFromGroupRequest
- default CompletableFuture<AdminResetUserPasswordResponse> adminResetUserPassword(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.default CompletableFuture<AdminRespondToAuthChallengeResponse> adminRespondToAuthChallenge(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.default CompletableFuture<AdminSetUserSettingsResponse> adminSetUserSettings(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.default CompletableFuture<AdminUpdateDeviceStatusResponse> adminUpdateDeviceStatus(AdminUpdateDeviceStatusRequest adminUpdateDeviceStatusRequest)
Updates the device status as an administrator.
Requires developer credentials.
adminUpdateDeviceStatusRequest
- The request to update the device status, as an administrator.default CompletableFuture<AdminUpdateUserAttributesResponse> adminUpdateUserAttributes(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.default CompletableFuture<AdminUserGlobalSignOutResponse> adminUserGlobalSignOut(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.default CompletableFuture<ChangePasswordResponse> changePassword(ChangePasswordRequest changePasswordRequest)
Changes the password for a specified user in a user pool.
changePasswordRequest
- Represents the request to change a user password.default CompletableFuture<ConfirmDeviceResponse> confirmDevice(ConfirmDeviceRequest confirmDeviceRequest)
Confirms tracking of the device. This API call is the call that begins device tracking.
confirmDeviceRequest
- Confirms the device request.default CompletableFuture<ConfirmForgotPasswordResponse> confirmForgotPassword(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.default CompletableFuture<ConfirmSignUpResponse> confirmSignUp(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.default CompletableFuture<CreateGroupResponse> createGroup(CreateGroupRequest createGroupRequest)
Creates a new group in the specified user pool.
Requires developer credentials.
createGroupRequest
- default CompletableFuture<CreateIdentityProviderResponse> createIdentityProvider(CreateIdentityProviderRequest createIdentityProviderRequest)
Creates an identity provider for a user pool.
createIdentityProviderRequest
- default CompletableFuture<CreateUserImportJobResponse> createUserImportJob(CreateUserImportJobRequest createUserImportJobRequest)
Creates the user import job.
createUserImportJobRequest
- Represents the request to create the user import job.default CompletableFuture<CreateUserPoolResponse> createUserPool(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.default CompletableFuture<CreateUserPoolClientResponse> createUserPoolClient(CreateUserPoolClientRequest createUserPoolClientRequest)
Creates the user pool client.
createUserPoolClientRequest
- Represents the request to create a user pool client.default CompletableFuture<CreateUserPoolDomainResponse> createUserPoolDomain(CreateUserPoolDomainRequest createUserPoolDomainRequest)
Creates a new domain for a user pool.
createUserPoolDomainRequest
- default CompletableFuture<DeleteGroupResponse> deleteGroup(DeleteGroupRequest deleteGroupRequest)
Deletes a group. Currently only groups with no members can be deleted.
Requires developer credentials.
deleteGroupRequest
- default CompletableFuture<DeleteIdentityProviderResponse> deleteIdentityProvider(DeleteIdentityProviderRequest deleteIdentityProviderRequest)
Deletes an identity provider for a user pool.
deleteIdentityProviderRequest
- default CompletableFuture<DeleteUserResponse> deleteUser(DeleteUserRequest deleteUserRequest)
Allows a user to delete one's self.
deleteUserRequest
- Represents the request to delete a user.default CompletableFuture<DeleteUserAttributesResponse> deleteUserAttributes(DeleteUserAttributesRequest deleteUserAttributesRequest)
Deletes the attributes for a user.
deleteUserAttributesRequest
- Represents the request to delete user attributes.default CompletableFuture<DeleteUserPoolResponse> deleteUserPool(DeleteUserPoolRequest deleteUserPoolRequest)
Deletes the specified Amazon Cognito user pool.
deleteUserPoolRequest
- Represents the request to delete a user pool.default CompletableFuture<DeleteUserPoolClientResponse> deleteUserPoolClient(DeleteUserPoolClientRequest deleteUserPoolClientRequest)
Allows the developer to delete the user pool client.
deleteUserPoolClientRequest
- Represents the request to delete a user pool client.default CompletableFuture<DeleteUserPoolDomainResponse> deleteUserPoolDomain(DeleteUserPoolDomainRequest deleteUserPoolDomainRequest)
Deletes a domain for a user pool.
deleteUserPoolDomainRequest
- default CompletableFuture<DescribeIdentityProviderResponse> describeIdentityProvider(DescribeIdentityProviderRequest describeIdentityProviderRequest)
Gets information about a specific identity provider.
describeIdentityProviderRequest
- default CompletableFuture<DescribeUserImportJobResponse> describeUserImportJob(DescribeUserImportJobRequest describeUserImportJobRequest)
Describes the user import job.
describeUserImportJobRequest
- Represents the request to describe the user import job.default CompletableFuture<DescribeUserPoolResponse> describeUserPool(DescribeUserPoolRequest describeUserPoolRequest)
Returns the configuration information and metadata of the specified user pool.
describeUserPoolRequest
- Represents the request to describe the user pool.default CompletableFuture<DescribeUserPoolClientResponse> describeUserPoolClient(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.default CompletableFuture<DescribeUserPoolDomainResponse> describeUserPoolDomain(DescribeUserPoolDomainRequest describeUserPoolDomainRequest)
Gets information about a domain.
describeUserPoolDomainRequest
- default CompletableFuture<ForgetDeviceResponse> forgetDevice(ForgetDeviceRequest forgetDeviceRequest)
Forgets the specified device.
forgetDeviceRequest
- Represents the request to forget the device.default CompletableFuture<ForgotPasswordResponse> forgotPassword(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.default CompletableFuture<GetCSVHeaderResponse> getCSVHeader(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.default CompletableFuture<GetDeviceResponse> getDevice(GetDeviceRequest getDeviceRequest)
Gets the device.
getDeviceRequest
- Represents the request to get the device.default CompletableFuture<GetGroupResponse> getGroup(GetGroupRequest getGroupRequest)
Gets a group.
Requires developer credentials.
getGroupRequest
- default CompletableFuture<GetIdentityProviderByIdentifierResponse> getIdentityProviderByIdentifier(GetIdentityProviderByIdentifierRequest getIdentityProviderByIdentifierRequest)
Gets the specified identity provider.
getIdentityProviderByIdentifierRequest
- default CompletableFuture<GetUserResponse> getUser(GetUserRequest getUserRequest)
Gets the user attributes and metadata for a user.
getUserRequest
- Represents the request to get information about the user.default CompletableFuture<GetUserAttributeVerificationCodeResponse> getUserAttributeVerificationCode(GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest)
Gets the user attribute verification code for the specified attribute name.
getUserAttributeVerificationCodeRequest
- Represents the request to get user attribute verification.default CompletableFuture<GlobalSignOutResponse> globalSignOut(GlobalSignOutRequest globalSignOutRequest)
Signs out users from all devices.
globalSignOutRequest
- Represents the request to sign out all devices.default CompletableFuture<InitiateAuthResponse> initiateAuth(InitiateAuthRequest initiateAuthRequest)
Initiates the authentication flow.
initiateAuthRequest
- Initiates the authentication request.default CompletableFuture<ListDevicesResponse> listDevices(ListDevicesRequest listDevicesRequest)
Lists the devices.
listDevicesRequest
- Represents the request to list the devices.default CompletableFuture<ListGroupsResponse> listGroups(ListGroupsRequest listGroupsRequest)
Lists the groups associated with a user pool.
Requires developer credentials.
listGroupsRequest
- default CompletableFuture<ListIdentityProvidersResponse> listIdentityProviders(ListIdentityProvidersRequest listIdentityProvidersRequest)
Lists information about all identity providers for a user pool.
listIdentityProvidersRequest
- default CompletableFuture<ListUserImportJobsResponse> listUserImportJobs(ListUserImportJobsRequest listUserImportJobsRequest)
Lists the user import jobs.
listUserImportJobsRequest
- Represents the request to list the user import jobs.default CompletableFuture<ListUserPoolClientsResponse> listUserPoolClients(ListUserPoolClientsRequest listUserPoolClientsRequest)
Lists the clients that have been created for the specified user pool.
listUserPoolClientsRequest
- Represents the request to list the user pool clients.default CompletableFuture<ListUserPoolsResponse> listUserPools(ListUserPoolsRequest listUserPoolsRequest)
Lists the user pools associated with an AWS account.
listUserPoolsRequest
- Represents the request to list user pools.default CompletableFuture<ListUsersResponse> listUsers(ListUsersRequest listUsersRequest)
Lists the users in the Amazon Cognito user pool.
listUsersRequest
- Represents the request to list users.default CompletableFuture<ListUsersInGroupResponse> listUsersInGroup(ListUsersInGroupRequest listUsersInGroupRequest)
Lists the users in the specified group.
Requires developer credentials.
listUsersInGroupRequest
- default CompletableFuture<ResendConfirmationCodeResponse> resendConfirmationCode(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.default CompletableFuture<RespondToAuthChallengeResponse> respondToAuthChallenge(RespondToAuthChallengeRequest respondToAuthChallengeRequest)
Responds to the authentication challenge.
respondToAuthChallengeRequest
- The request to respond to an authentication challenge.default CompletableFuture<SetUserSettingsResponse> setUserSettings(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.default CompletableFuture<SignUpResponse> signUp(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.default CompletableFuture<StartUserImportJobResponse> startUserImportJob(StartUserImportJobRequest startUserImportJobRequest)
Starts the user import.
startUserImportJobRequest
- Represents the request to start the user import job.default CompletableFuture<StopUserImportJobResponse> stopUserImportJob(StopUserImportJobRequest stopUserImportJobRequest)
Stops the user import job.
stopUserImportJobRequest
- Represents the request to stop the user import job.default CompletableFuture<UpdateDeviceStatusResponse> updateDeviceStatus(UpdateDeviceStatusRequest updateDeviceStatusRequest)
Updates the device status.
updateDeviceStatusRequest
- Represents the request to update the device status.default CompletableFuture<UpdateGroupResponse> updateGroup(UpdateGroupRequest updateGroupRequest)
Updates the specified group with the specified attributes.
Requires developer credentials.
updateGroupRequest
- default CompletableFuture<UpdateIdentityProviderResponse> updateIdentityProvider(UpdateIdentityProviderRequest updateIdentityProviderRequest)
Updates identity provider information for a user pool.
updateIdentityProviderRequest
- default CompletableFuture<UpdateUserAttributesResponse> updateUserAttributes(UpdateUserAttributesRequest updateUserAttributesRequest)
Allows a user to update a specific attribute (one at a time).
updateUserAttributesRequest
- Represents the request to update user attributes.default CompletableFuture<UpdateUserPoolResponse> updateUserPool(UpdateUserPoolRequest updateUserPoolRequest)
Updates the specified user pool with the specified attributes.
updateUserPoolRequest
- Represents the request to update the user pool.default CompletableFuture<UpdateUserPoolClientResponse> updateUserPoolClient(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.default CompletableFuture<VerifyUserAttributeResponse> verifyUserAttribute(VerifyUserAttributeRequest verifyUserAttributeRequest)
Verifies the specified user attributes in the user pool.
verifyUserAttributeRequest
- Represents the request to verify user attributes.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.