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