@Generated(value="software.amazon.awssdk:codegen") public interface CognitoIdentityProviderAsyncClient extends SdkClient
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.
|
default CompletableFuture<AdminCreateUserResponse> |
adminCreateUser(Consumer<AdminCreateUserRequest.Builder> adminCreateUserRequest)
Creates a new user in the specified user pool.
|
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.
|
default CompletableFuture<AdminDisableUserResponse> |
adminDisableUser(Consumer<AdminDisableUserRequest.Builder> adminDisableUserRequest)
Disables the specified user.
|
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 AdminListGroupsForUserPublisher |
adminListGroupsForUserPaginator(AdminListGroupsForUserRequest adminListGroupsForUserRequest)
Lists the groups that the user belongs to.
|
default AdminListGroupsForUserPublisher |
adminListGroupsForUserPaginator(Consumer<AdminListGroupsForUserRequest.Builder> adminListGroupsForUserRequest)
Lists the groups that the user belongs to.
|
default CompletableFuture<AdminListUserAuthEventsResponse> |
adminListUserAuthEvents(AdminListUserAuthEventsRequest adminListUserAuthEventsRequest)
Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security.
|
default CompletableFuture<AdminListUserAuthEventsResponse> |
adminListUserAuthEvents(Consumer<AdminListUserAuthEventsRequest.Builder> adminListUserAuthEventsRequest)
Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security.
|
default AdminListUserAuthEventsPublisher |
adminListUserAuthEventsPaginator(AdminListUserAuthEventsRequest adminListUserAuthEventsRequest)
Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security.
|
default AdminListUserAuthEventsPublisher |
adminListUserAuthEventsPaginator(Consumer<AdminListUserAuthEventsRequest.Builder> adminListUserAuthEventsRequest)
Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security.
|
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<AdminSetUserMfaPreferenceResponse> |
adminSetUserMFAPreference(AdminSetUserMfaPreferenceRequest adminSetUserMfaPreferenceRequest)
Sets the user's multi-factor authentication (MFA) preference, including which MFA options are enabled and if any
are preferred.
|
default CompletableFuture<AdminSetUserMfaPreferenceResponse> |
adminSetUserMFAPreference(Consumer<AdminSetUserMfaPreferenceRequest.Builder> adminSetUserMfaPreferenceRequest)
Sets the user's multi-factor authentication (MFA) preference, including which MFA options are enabled and if any
are preferred.
|
default CompletableFuture<AdminSetUserPasswordResponse> |
adminSetUserPassword(AdminSetUserPasswordRequest adminSetUserPasswordRequest)
Sets the specified user's password in a user pool as an administrator.
|
default CompletableFuture<AdminSetUserPasswordResponse> |
adminSetUserPassword(Consumer<AdminSetUserPasswordRequest.Builder> adminSetUserPasswordRequest)
Sets the specified user's password in a user pool as an administrator.
|
default CompletableFuture<AdminSetUserSettingsResponse> |
adminSetUserSettings(AdminSetUserSettingsRequest adminSetUserSettingsRequest)
This action is no longer supported. You can use it to configure only SMS MFA.
|
default CompletableFuture<AdminSetUserSettingsResponse> |
adminSetUserSettings(Consumer<AdminSetUserSettingsRequest.Builder> adminSetUserSettingsRequest)
This action is no longer supported. You can use it to configure only SMS MFA.
|
default CompletableFuture<AdminUpdateAuthEventFeedbackResponse> |
adminUpdateAuthEventFeedback(AdminUpdateAuthEventFeedbackRequest adminUpdateAuthEventFeedbackRequest)
Provides feedback for an authentication event as to whether it was from a valid user.
|
default CompletableFuture<AdminUpdateAuthEventFeedbackResponse> |
adminUpdateAuthEventFeedback(Consumer<AdminUpdateAuthEventFeedbackRequest.Builder> adminUpdateAuthEventFeedbackRequest)
Provides feedback for an authentication event as to whether it was from a valid user.
|
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.
|
default CompletableFuture<AssociateSoftwareTokenResponse> |
associateSoftwareToken(AssociateSoftwareTokenRequest associateSoftwareTokenRequest)
Returns a unique generated shared secret key code for the user account.
|
default CompletableFuture<AssociateSoftwareTokenResponse> |
associateSoftwareToken(Consumer<AssociateSoftwareTokenRequest.Builder> associateSoftwareTokenRequest)
Returns a unique generated shared secret key code for the user account.
|
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<DescribeRiskConfigurationResponse> |
describeRiskConfiguration(Consumer<DescribeRiskConfigurationRequest.Builder> describeRiskConfigurationRequest)
Describes the risk configuration.
|
default CompletableFuture<DescribeRiskConfigurationResponse> |
describeRiskConfiguration(DescribeRiskConfigurationRequest describeRiskConfigurationRequest)
Describes the risk configuration.
|
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 app client.
|
default CompletableFuture<DescribeUserPoolClientResponse> |
describeUserPoolClient(DescribeUserPoolClientRequest describeUserPoolClientRequest)
Client method for returning the configuration information and metadata of the specified user pool app 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<GetSigningCertificateResponse> |
getSigningCertificate(Consumer<GetSigningCertificateRequest.Builder> getSigningCertificateRequest)
This method takes a user pool ID, and returns the signing certificate.
|
default CompletableFuture<GetSigningCertificateResponse> |
getSigningCertificate(GetSigningCertificateRequest getSigningCertificateRequest)
This method takes a user pool ID, and returns the signing certificate.
|
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<GetUserPoolMfaConfigResponse> |
getUserPoolMfaConfig(Consumer<GetUserPoolMfaConfigRequest.Builder> getUserPoolMfaConfigRequest)
Gets the user pool multi-factor authentication (MFA) configuration.
|
default CompletableFuture<GetUserPoolMfaConfigResponse> |
getUserPoolMfaConfig(GetUserPoolMfaConfigRequest getUserPoolMfaConfigRequest)
Gets the user pool multi-factor authentication (MFA) configuration.
|
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 ListGroupsPublisher |
listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
Lists the groups associated with a user pool.
|
default ListGroupsPublisher |
listGroupsPaginator(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 ListIdentityProvidersPublisher |
listIdentityProvidersPaginator(Consumer<ListIdentityProvidersRequest.Builder> listIdentityProvidersRequest)
Lists information about all identity providers for a user pool.
|
default ListIdentityProvidersPublisher |
listIdentityProvidersPaginator(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 ListResourceServersPublisher |
listResourceServersPaginator(Consumer<ListResourceServersRequest.Builder> listResourceServersRequest)
Lists the resource servers for a user pool.
|
default ListResourceServersPublisher |
listResourceServersPaginator(ListResourceServersRequest listResourceServersRequest)
Lists the resource servers for a user pool.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags that are assigned to an Amazon Cognito user pool.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags that are assigned to an Amazon Cognito 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 ListUserPoolClientsPublisher |
listUserPoolClientsPaginator(Consumer<ListUserPoolClientsRequest.Builder> listUserPoolClientsRequest)
Lists the clients that have been created for the specified user pool.
|
default ListUserPoolClientsPublisher |
listUserPoolClientsPaginator(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 ListUserPoolsPublisher |
listUserPoolsPaginator(Consumer<ListUserPoolsRequest.Builder> listUserPoolsRequest)
Lists the user pools associated with an AWS account.
|
default ListUserPoolsPublisher |
listUserPoolsPaginator(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 ListUsersInGroupPublisher |
listUsersInGroupPaginator(Consumer<ListUsersInGroupRequest.Builder> listUsersInGroupRequest)
Lists the users in the specified group.
|
default ListUsersInGroupPublisher |
listUsersInGroupPaginator(ListUsersInGroupRequest listUsersInGroupRequest)
Lists the users in the specified group.
|
default ListUsersPublisher |
listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest)
Lists the users in the Amazon Cognito user pool.
|
default ListUsersPublisher |
listUsersPaginator(ListUsersRequest listUsersRequest)
Lists the users in the Amazon Cognito user pool.
|
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<SetRiskConfigurationResponse> |
setRiskConfiguration(Consumer<SetRiskConfigurationRequest.Builder> setRiskConfigurationRequest)
Configures actions on detected risks.
|
default CompletableFuture<SetRiskConfigurationResponse> |
setRiskConfiguration(SetRiskConfigurationRequest setRiskConfigurationRequest)
Configures actions on detected risks.
|
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<SetUserMfaPreferenceResponse> |
setUserMFAPreference(Consumer<SetUserMfaPreferenceRequest.Builder> setUserMfaPreferenceRequest)
Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are enabled and
if any are preferred.
|
default CompletableFuture<SetUserMfaPreferenceResponse> |
setUserMFAPreference(SetUserMfaPreferenceRequest setUserMfaPreferenceRequest)
Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are enabled and
if any are preferred.
|
default CompletableFuture<SetUserPoolMfaConfigResponse> |
setUserPoolMfaConfig(Consumer<SetUserPoolMfaConfigRequest.Builder> setUserPoolMfaConfigRequest)
Set the user pool multi-factor authentication (MFA) configuration.
|
default CompletableFuture<SetUserPoolMfaConfigResponse> |
setUserPoolMfaConfig(SetUserPoolMfaConfigRequest setUserPoolMfaConfigRequest)
Set the user pool multi-factor authentication (MFA) configuration.
|
default CompletableFuture<SetUserSettingsResponse> |
setUserSettings(Consumer<SetUserSettingsRequest.Builder> setUserSettingsRequest)
This action is no longer supported. You can use it to configure only SMS MFA.
|
default CompletableFuture<SetUserSettingsResponse> |
setUserSettings(SetUserSettingsRequest setUserSettingsRequest)
This action is no longer supported. You can use it to configure only SMS 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<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Assigns a set of tags to an Amazon Cognito user pool.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Assigns a set of tags to an Amazon Cognito user pool.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes the specified tags from an Amazon Cognito user pool.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes the specified tags from an Amazon Cognito user pool.
|
default CompletableFuture<UpdateAuthEventFeedbackResponse> |
updateAuthEventFeedback(Consumer<UpdateAuthEventFeedbackRequest.Builder> updateAuthEventFeedbackRequest)
Provides the feedback for an authentication event whether it was from a valid user or not.
|
default CompletableFuture<UpdateAuthEventFeedbackResponse> |
updateAuthEventFeedback(UpdateAuthEventFeedbackRequest updateAuthEventFeedbackRequest)
Provides the feedback for an authentication event whether it was from a valid user or not.
|
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)
Updates the specified user pool app client with the specified attributes.
|
default CompletableFuture<UpdateUserPoolClientResponse> |
updateUserPoolClient(UpdateUserPoolClientRequest updateUserPoolClientRequest)
Updates the specified user pool app client with the specified attributes.
|
default CompletableFuture<UpdateUserPoolDomainResponse> |
updateUserPoolDomain(Consumer<UpdateUserPoolDomainRequest.Builder> updateUserPoolDomainRequest)
Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.
|
default CompletableFuture<UpdateUserPoolDomainResponse> |
updateUserPoolDomain(UpdateUserPoolDomainRequest updateUserPoolDomainRequest)
Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.
|
default CompletableFuture<VerifySoftwareTokenResponse> |
verifySoftwareToken(Consumer<VerifySoftwareTokenRequest.Builder> verifySoftwareTokenRequest)
Use this API to register a user's entered TOTP code and mark the user's software token MFA status as "verified"
if successful.
|
default CompletableFuture<VerifySoftwareTokenResponse> |
verifySoftwareToken(VerifySoftwareTokenRequest verifySoftwareTokenRequest)
Use this API to register a user's entered TOTP code and mark the user's software token MFA status as "verified"
if successful.
|
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.
This is a convenience which creates an instance of the AddCustomAttributesRequest.Builder
avoiding the
need to create one manually via AddCustomAttributesRequest.builder()
addCustomAttributesRequest
- A Consumer
that will call methods on AddCustomAttributesRequest.Builder
to create a
request. Represents the request to add custom attributes.default CompletableFuture<AdminAddUserToGroupResponse> adminAddUserToGroup(AdminAddUserToGroupRequest adminAddUserToGroupRequest)
Adds the specified user to the specified group.
Calling this action requires developer credentials.
adminAddUserToGroupRequest
- default CompletableFuture<AdminAddUserToGroupResponse> adminAddUserToGroup(Consumer<AdminAddUserToGroupRequest.Builder> adminAddUserToGroupRequest)
Adds the specified user to the specified group.
Calling this action requires developer credentials.
This is a convenience which creates an instance of the AdminAddUserToGroupRequest.Builder
avoiding the
need to create one manually via AdminAddUserToGroupRequest.builder()
adminAddUserToGroupRequest
- A Consumer
that will call methods on AdminAddUserToGroupRequest.Builder
to create a
request.default CompletableFuture<AdminConfirmSignUpResponse> adminConfirmSignUp(AdminConfirmSignUpRequest adminConfirmSignUpRequest)
Confirms user registration as an admin without using a confirmation code. Works on any user.
Calling this action 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.
Calling this action requires developer credentials.
This is a convenience which creates an instance of the AdminConfirmSignUpRequest.Builder
avoiding the
need to create one manually via AdminConfirmSignUpRequest.builder()
adminConfirmSignUpRequest
- A Consumer
that will call methods on AdminConfirmSignUpRequest.Builder
to create a
request. Represents the request to confirm user registration.default CompletableFuture<AdminCreateUserResponse> adminCreateUser(AdminCreateUserRequest adminCreateUserRequest)
Creates a new user in the specified user pool.
If MessageAction
is not set, the default is to send a welcome message via email or phone (SMS).
This message is based on a template that you configured in your call to create or update a user pool. This template includes your custom sign-up instructions and placeholders for user name and temporary password.
Alternatively, you can call AdminCreateUser
with “SUPPRESS” for the MessageAction
parameter, and Amazon Cognito will not send any email.
In either case, the user will be in the FORCE_CHANGE_PASSWORD
state until they sign in and change
their password.
AdminCreateUser
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.
If MessageAction
is not set, the default is to send a welcome message via email or phone (SMS).
This message is based on a template that you configured in your call to create or update a user pool. This template includes your custom sign-up instructions and placeholders for user name and temporary password.
Alternatively, you can call AdminCreateUser
with “SUPPRESS” for the MessageAction
parameter, and Amazon Cognito will not send any email.
In either case, the user will be in the FORCE_CHANGE_PASSWORD
state until they sign in and change
their password.
AdminCreateUser
requires developer credentials.
This is a convenience which creates an instance of the AdminCreateUserRequest.Builder
avoiding the need
to create one manually via AdminCreateUserRequest.builder()
adminCreateUserRequest
- A Consumer
that will call methods on AdminCreateUserRequest.Builder
to create a request.
Represents the request to create a user in the specified user pool.default CompletableFuture<AdminDeleteUserResponse> adminDeleteUser(AdminDeleteUserRequest adminDeleteUserRequest)
Deletes a user as an administrator. Works on any user.
Calling this action 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.
Calling this action requires developer credentials.
This is a convenience which creates an instance of the AdminDeleteUserRequest.Builder
avoiding the need
to create one manually via AdminDeleteUserRequest.builder()
adminDeleteUserRequest
- A Consumer
that will call methods on AdminDeleteUserRequest.Builder
to create a request.
Represents the request to delete a user as an administrator.default CompletableFuture<AdminDeleteUserAttributesResponse> adminDeleteUserAttributes(AdminDeleteUserAttributesRequest adminDeleteUserAttributesRequest)
Deletes the user attributes in a user pool as an administrator. Works on any user.
Calling this action 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.
Calling this action requires developer credentials.
This is a convenience which creates an instance of the AdminDeleteUserAttributesRequest.Builder
avoiding
the need to create one manually via AdminDeleteUserAttributesRequest.builder()
adminDeleteUserAttributesRequest
- A Consumer
that will call methods on AdminDeleteUserAttributesRequest.Builder
to create a
request. Represents the request to delete user attributes as an administrator.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 using
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 using
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.
This is a convenience which creates an instance of the AdminDisableProviderForUserRequest.Builder
avoiding the need to create one manually via AdminDisableProviderForUserRequest.builder()
adminDisableProviderForUserRequest
- A Consumer
that will call methods on AdminDisableProviderForUserRequest.Builder
to create
a request.default CompletableFuture<AdminDisableUserResponse> adminDisableUser(AdminDisableUserRequest adminDisableUserRequest)
Disables the specified user.
Calling this action 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.
Calling this action requires developer credentials.
This is a convenience which creates an instance of the AdminDisableUserRequest.Builder
avoiding the need
to create one manually via AdminDisableUserRequest.builder()
adminDisableUserRequest
- A Consumer
that will call methods on AdminDisableUserRequest.Builder
to create a request.
Represents the request to disable any user as an administrator.default CompletableFuture<AdminEnableUserResponse> adminEnableUser(AdminEnableUserRequest adminEnableUserRequest)
Enables the specified user as an administrator. Works on any user.
Calling this action 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.
Calling this action requires developer credentials.
This is a convenience which creates an instance of the AdminEnableUserRequest.Builder
avoiding the need
to create one manually via AdminEnableUserRequest.builder()
adminEnableUserRequest
- A Consumer
that will call methods on AdminEnableUserRequest.Builder
to create a request.
Represents the request that enables the user as an administrator.default CompletableFuture<AdminForgetDeviceResponse> adminForgetDevice(AdminForgetDeviceRequest adminForgetDeviceRequest)
Forgets the device, as an administrator.
Calling this action 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.
Calling this action requires developer credentials.
This is a convenience which creates an instance of the AdminForgetDeviceRequest.Builder
avoiding the need
to create one manually via AdminForgetDeviceRequest.builder()
adminForgetDeviceRequest
- A Consumer
that will call methods on AdminForgetDeviceRequest.Builder
to create a request.
Sends the forgot device request, as an administrator.default CompletableFuture<AdminGetDeviceResponse> adminGetDevice(AdminGetDeviceRequest adminGetDeviceRequest)
Gets the device, as an administrator.
Calling this action 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.
Calling this action requires developer credentials.
This is a convenience which creates an instance of the AdminGetDeviceRequest.Builder
avoiding the need to
create one manually via AdminGetDeviceRequest.builder()
adminGetDeviceRequest
- A Consumer
that will call methods on AdminGetDeviceRequest.Builder
to create a request.
Represents the request to get the device, as an administrator.default CompletableFuture<AdminGetUserResponse> adminGetUser(AdminGetUserRequest adminGetUserRequest)
Gets the specified user by user name in a user pool as an administrator. Works on any user.
Calling this action 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.
Calling this action requires developer credentials.
This is a convenience which creates an instance of the AdminGetUserRequest.Builder
avoiding the need to
create one manually via AdminGetUserRequest.builder()
adminGetUserRequest
- A Consumer
that will call methods on AdminGetUserRequest.Builder
to create a request.
Represents the request to get the specified user as an administrator.default CompletableFuture<AdminInitiateAuthResponse> adminInitiateAuth(AdminInitiateAuthRequest adminInitiateAuthRequest)
Initiates the authentication flow, as an administrator.
Calling this action 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.
Calling this action requires developer credentials.
This is a convenience which creates an instance of the AdminInitiateAuthRequest.Builder
avoiding the need
to create one manually via AdminInitiateAuthRequest.builder()
adminInitiateAuthRequest
- A Consumer
that will call methods on AdminInitiateAuthRequest.Builder
to create a request.
Initiates the authorization request, 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. 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.
The maximum number of federated identities linked to a user is 5.
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.
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.
The maximum number of federated identities linked to a user is 5.
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.
This action is enabled only for admin access and requires developer credentials.
This is a convenience which creates an instance of the AdminLinkProviderForUserRequest.Builder
avoiding
the need to create one manually via AdminLinkProviderForUserRequest.builder()
adminLinkProviderForUserRequest
- A Consumer
that will call methods on AdminLinkProviderForUserRequest.Builder
to create a
request.default CompletableFuture<AdminListDevicesResponse> adminListDevices(AdminListDevicesRequest adminListDevicesRequest)
Lists devices, as an administrator.
Calling this action 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.
Calling this action requires developer credentials.
This is a convenience which creates an instance of the AdminListDevicesRequest.Builder
avoiding the need
to create one manually via AdminListDevicesRequest.builder()
adminListDevicesRequest
- A Consumer
that will call methods on AdminListDevicesRequest.Builder
to create a request.
Represents the request to list devices, as an administrator.default CompletableFuture<AdminListGroupsForUserResponse> adminListGroupsForUser(AdminListGroupsForUserRequest adminListGroupsForUserRequest)
Lists the groups that the user belongs to.
Calling this action requires developer credentials.
adminListGroupsForUserRequest
- default CompletableFuture<AdminListGroupsForUserResponse> adminListGroupsForUser(Consumer<AdminListGroupsForUserRequest.Builder> adminListGroupsForUserRequest)
Lists the groups that the user belongs to.
Calling this action requires developer credentials.
This is a convenience which creates an instance of the AdminListGroupsForUserRequest.Builder
avoiding the
need to create one manually via AdminListGroupsForUserRequest.builder()
adminListGroupsForUserRequest
- A Consumer
that will call methods on AdminListGroupsForUserRequest.Builder
to create a
request.default AdminListGroupsForUserPublisher adminListGroupsForUserPaginator(AdminListGroupsForUserRequest adminListGroupsForUserRequest)
Lists the groups that the user belongs to.
Calling this action requires developer credentials.
This is a variant of
adminListGroupsForUser(software.amazon.awssdk.services.cognitoidentityprovider.model.AdminListGroupsForUserRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cognitoidentityprovider.paginators.AdminListGroupsForUserPublisher publisher = client.adminListGroupsForUserPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cognitoidentityprovider.paginators.AdminListGroupsForUserPublisher publisher = client.adminListGroupsForUserPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cognitoidentityprovider.model.AdminListGroupsForUserResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cognitoidentityprovider.model.AdminListGroupsForUserResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
adminListGroupsForUser(software.amazon.awssdk.services.cognitoidentityprovider.model.AdminListGroupsForUserRequest)
operation.
adminListGroupsForUserRequest
- default AdminListGroupsForUserPublisher adminListGroupsForUserPaginator(Consumer<AdminListGroupsForUserRequest.Builder> adminListGroupsForUserRequest)
Lists the groups that the user belongs to.
Calling this action requires developer credentials.
This is a variant of
adminListGroupsForUser(software.amazon.awssdk.services.cognitoidentityprovider.model.AdminListGroupsForUserRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cognitoidentityprovider.paginators.AdminListGroupsForUserPublisher publisher = client.adminListGroupsForUserPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cognitoidentityprovider.paginators.AdminListGroupsForUserPublisher publisher = client.adminListGroupsForUserPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cognitoidentityprovider.model.AdminListGroupsForUserResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cognitoidentityprovider.model.AdminListGroupsForUserResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
adminListGroupsForUser(software.amazon.awssdk.services.cognitoidentityprovider.model.AdminListGroupsForUserRequest)
operation.
This is a convenience which creates an instance of the AdminListGroupsForUserRequest.Builder
avoiding the
need to create one manually via AdminListGroupsForUserRequest.builder()
adminListGroupsForUserRequest
- A Consumer
that will call methods on AdminListGroupsForUserRequest.Builder
to create a
request.default CompletableFuture<AdminListUserAuthEventsResponse> adminListUserAuthEvents(AdminListUserAuthEventsRequest adminListUserAuthEventsRequest)
Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security.
adminListUserAuthEventsRequest
- default CompletableFuture<AdminListUserAuthEventsResponse> adminListUserAuthEvents(Consumer<AdminListUserAuthEventsRequest.Builder> adminListUserAuthEventsRequest)
Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security.
This is a convenience which creates an instance of the AdminListUserAuthEventsRequest.Builder
avoiding
the need to create one manually via AdminListUserAuthEventsRequest.builder()
adminListUserAuthEventsRequest
- A Consumer
that will call methods on AdminListUserAuthEventsRequest.Builder
to create a
request.default AdminListUserAuthEventsPublisher adminListUserAuthEventsPaginator(AdminListUserAuthEventsRequest adminListUserAuthEventsRequest)
Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security.
This is a variant of
adminListUserAuthEvents(software.amazon.awssdk.services.cognitoidentityprovider.model.AdminListUserAuthEventsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cognitoidentityprovider.paginators.AdminListUserAuthEventsPublisher publisher = client.adminListUserAuthEventsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cognitoidentityprovider.paginators.AdminListUserAuthEventsPublisher publisher = client.adminListUserAuthEventsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cognitoidentityprovider.model.AdminListUserAuthEventsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cognitoidentityprovider.model.AdminListUserAuthEventsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
adminListUserAuthEvents(software.amazon.awssdk.services.cognitoidentityprovider.model.AdminListUserAuthEventsRequest)
operation.
adminListUserAuthEventsRequest
- default AdminListUserAuthEventsPublisher adminListUserAuthEventsPaginator(Consumer<AdminListUserAuthEventsRequest.Builder> adminListUserAuthEventsRequest)
Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security.
This is a variant of
adminListUserAuthEvents(software.amazon.awssdk.services.cognitoidentityprovider.model.AdminListUserAuthEventsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cognitoidentityprovider.paginators.AdminListUserAuthEventsPublisher publisher = client.adminListUserAuthEventsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cognitoidentityprovider.paginators.AdminListUserAuthEventsPublisher publisher = client.adminListUserAuthEventsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cognitoidentityprovider.model.AdminListUserAuthEventsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cognitoidentityprovider.model.AdminListUserAuthEventsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
adminListUserAuthEvents(software.amazon.awssdk.services.cognitoidentityprovider.model.AdminListUserAuthEventsRequest)
operation.
This is a convenience which creates an instance of the AdminListUserAuthEventsRequest.Builder
avoiding
the need to create one manually via AdminListUserAuthEventsRequest.builder()
adminListUserAuthEventsRequest
- A Consumer
that will call methods on AdminListUserAuthEventsRequest.Builder
to create a
request.default CompletableFuture<AdminRemoveUserFromGroupResponse> adminRemoveUserFromGroup(AdminRemoveUserFromGroupRequest adminRemoveUserFromGroupRequest)
Removes the specified user from the specified group.
Calling this action requires developer credentials.
adminRemoveUserFromGroupRequest
- default CompletableFuture<AdminRemoveUserFromGroupResponse> adminRemoveUserFromGroup(Consumer<AdminRemoveUserFromGroupRequest.Builder> adminRemoveUserFromGroupRequest)
Removes the specified user from the specified group.
Calling this action requires developer credentials.
This is a convenience which creates an instance of the AdminRemoveUserFromGroupRequest.Builder
avoiding
the need to create one manually via AdminRemoveUserFromGroupRequest.builder()
adminRemoveUserFromGroupRequest
- A Consumer
that will call methods on AdminRemoveUserFromGroupRequest.Builder
to create a
request.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.
Calling this action 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.
Calling this action requires developer credentials.
This is a convenience which creates an instance of the AdminResetUserPasswordRequest.Builder
avoiding the
need to create one manually via AdminResetUserPasswordRequest.builder()
adminResetUserPasswordRequest
- A Consumer
that will call methods on AdminResetUserPasswordRequest.Builder
to create a
request. Represents the request to reset a user's password as an administrator.default CompletableFuture<AdminRespondToAuthChallengeResponse> adminRespondToAuthChallenge(AdminRespondToAuthChallengeRequest adminRespondToAuthChallengeRequest)
Responds to an authentication challenge, as an administrator.
Calling this action 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.
Calling this action requires developer credentials.
This is a convenience which creates an instance of the AdminRespondToAuthChallengeRequest.Builder
avoiding the need to create one manually via AdminRespondToAuthChallengeRequest.builder()
adminRespondToAuthChallengeRequest
- A Consumer
that will call methods on AdminRespondToAuthChallengeRequest.Builder
to create
a request. The request to respond to the authentication challenge, as an administrator.default CompletableFuture<AdminSetUserMfaPreferenceResponse> adminSetUserMFAPreference(AdminSetUserMfaPreferenceRequest adminSetUserMfaPreferenceRequest)
Sets the user's multi-factor authentication (MFA) preference, including which MFA options are enabled and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are enabled. If multiple options are enabled and no preference is set, a challenge to choose an MFA option will be returned during sign in.
adminSetUserMfaPreferenceRequest
- default CompletableFuture<AdminSetUserMfaPreferenceResponse> adminSetUserMFAPreference(Consumer<AdminSetUserMfaPreferenceRequest.Builder> adminSetUserMfaPreferenceRequest)
Sets the user's multi-factor authentication (MFA) preference, including which MFA options are enabled and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are enabled. If multiple options are enabled and no preference is set, a challenge to choose an MFA option will be returned during sign in.
This is a convenience which creates an instance of the AdminSetUserMfaPreferenceRequest.Builder
avoiding
the need to create one manually via AdminSetUserMfaPreferenceRequest.builder()
adminSetUserMfaPreferenceRequest
- A Consumer
that will call methods on AdminSetUserMFAPreferenceRequest.Builder
to create a
request.default CompletableFuture<AdminSetUserPasswordResponse> adminSetUserPassword(AdminSetUserPasswordRequest adminSetUserPasswordRequest)
Sets the specified user's password in a user pool as an administrator. Works on any user.
The password can be temporary or permanent. If it is temporary, the user status will be placed into the
FORCE_CHANGE_PASSWORD
state. When the user next tries to sign in, the InitiateAuth/AdminInitiateAuth
response will contain the NEW_PASSWORD_REQUIRED
challenge. If the user does not sign in before it
expires, the user will not be able to sign in and their password will need to be reset by an administrator.
Once the user has set a new password, or the password is permanent, the user status will be set to
Confirmed
.
adminSetUserPasswordRequest
- default CompletableFuture<AdminSetUserPasswordResponse> adminSetUserPassword(Consumer<AdminSetUserPasswordRequest.Builder> adminSetUserPasswordRequest)
Sets the specified user's password in a user pool as an administrator. Works on any user.
The password can be temporary or permanent. If it is temporary, the user status will be placed into the
FORCE_CHANGE_PASSWORD
state. When the user next tries to sign in, the InitiateAuth/AdminInitiateAuth
response will contain the NEW_PASSWORD_REQUIRED
challenge. If the user does not sign in before it
expires, the user will not be able to sign in and their password will need to be reset by an administrator.
Once the user has set a new password, or the password is permanent, the user status will be set to
Confirmed
.
This is a convenience which creates an instance of the AdminSetUserPasswordRequest.Builder
avoiding the
need to create one manually via AdminSetUserPasswordRequest.builder()
adminSetUserPasswordRequest
- A Consumer
that will call methods on AdminSetUserPasswordRequest.Builder
to create a
request.default CompletableFuture<AdminSetUserSettingsResponse> adminSetUserSettings(AdminSetUserSettingsRequest adminSetUserSettingsRequest)
This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either type of MFA, use AdminSetUserMFAPreference instead.
adminSetUserSettingsRequest
- You can use this parameter to set an MFA configuration that uses the SMS delivery medium.default CompletableFuture<AdminSetUserSettingsResponse> adminSetUserSettings(Consumer<AdminSetUserSettingsRequest.Builder> adminSetUserSettingsRequest)
This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either type of MFA, use AdminSetUserMFAPreference instead.
This is a convenience which creates an instance of the AdminSetUserSettingsRequest.Builder
avoiding the
need to create one manually via AdminSetUserSettingsRequest.builder()
adminSetUserSettingsRequest
- A Consumer
that will call methods on AdminSetUserSettingsRequest.Builder
to create a
request. You can use this parameter to set an MFA configuration that uses the SMS delivery medium.default CompletableFuture<AdminUpdateAuthEventFeedbackResponse> adminUpdateAuthEventFeedback(AdminUpdateAuthEventFeedbackRequest adminUpdateAuthEventFeedbackRequest)
Provides feedback for an authentication event as to whether it was from a valid user. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.
adminUpdateAuthEventFeedbackRequest
- default CompletableFuture<AdminUpdateAuthEventFeedbackResponse> adminUpdateAuthEventFeedback(Consumer<AdminUpdateAuthEventFeedbackRequest.Builder> adminUpdateAuthEventFeedbackRequest)
Provides feedback for an authentication event as to whether it was from a valid user. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.
This is a convenience which creates an instance of the AdminUpdateAuthEventFeedbackRequest.Builder
avoiding the need to create one manually via AdminUpdateAuthEventFeedbackRequest.builder()
adminUpdateAuthEventFeedbackRequest
- A Consumer
that will call methods on AdminUpdateAuthEventFeedbackRequest.Builder
to create
a request.default CompletableFuture<AdminUpdateDeviceStatusResponse> adminUpdateDeviceStatus(AdminUpdateDeviceStatusRequest adminUpdateDeviceStatusRequest)
Updates the device status as an administrator.
Calling this action 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.
Calling this action requires developer credentials.
This is a convenience which creates an instance of the AdminUpdateDeviceStatusRequest.Builder
avoiding
the need to create one manually via AdminUpdateDeviceStatusRequest.builder()
adminUpdateDeviceStatusRequest
- A Consumer
that will call methods on AdminUpdateDeviceStatusRequest.Builder
to create a
request. The request to update the device status, as an administrator.default CompletableFuture<AdminUpdateUserAttributesResponse> adminUpdateUserAttributes(AdminUpdateUserAttributesRequest adminUpdateUserAttributesRequest)
Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.
For custom attributes, you must prepend the custom:
prefix to the attribute name.
In addition to updating user attributes, this API can also be used to mark phone and email as verified.
Calling this action 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.
Calling this action requires developer credentials.
This is a convenience which creates an instance of the AdminUpdateUserAttributesRequest.Builder
avoiding
the need to create one manually via AdminUpdateUserAttributesRequest.builder()
adminUpdateUserAttributesRequest
- A Consumer
that will call methods on AdminUpdateUserAttributesRequest.Builder
to create a
request. Represents the request to update the user's attributes as an administrator.default CompletableFuture<AdminUserGlobalSignOutResponse> adminUserGlobalSignOut(AdminUserGlobalSignOutRequest adminUserGlobalSignOutRequest)
Signs out users from all devices, as an administrator. It also invalidates all refresh tokens issued to a user. The user's current access and Id tokens remain valid until their expiry. Access and Id tokens expire one hour after they are issued.
Calling this action 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. It also invalidates all refresh tokens issued to a user. The user's current access and Id tokens remain valid until their expiry. Access and Id tokens expire one hour after they are issued.
Calling this action requires developer credentials.
This is a convenience which creates an instance of the AdminUserGlobalSignOutRequest.Builder
avoiding the
need to create one manually via AdminUserGlobalSignOutRequest.builder()
adminUserGlobalSignOutRequest
- A Consumer
that will call methods on AdminUserGlobalSignOutRequest.Builder
to create a
request. The request to sign out of all devices, as an administrator.default CompletableFuture<AssociateSoftwareTokenResponse> associateSoftwareToken(AssociateSoftwareTokenRequest associateSoftwareTokenRequest)
Returns a unique generated shared secret key code for the user account. The request takes an access token or a session string, but not both.
associateSoftwareTokenRequest
- default CompletableFuture<AssociateSoftwareTokenResponse> associateSoftwareToken(Consumer<AssociateSoftwareTokenRequest.Builder> associateSoftwareTokenRequest)
Returns a unique generated shared secret key code for the user account. The request takes an access token or a session string, but not both.
This is a convenience which creates an instance of the AssociateSoftwareTokenRequest.Builder
avoiding the
need to create one manually via AssociateSoftwareTokenRequest.builder()
associateSoftwareTokenRequest
- A Consumer
that will call methods on AssociateSoftwareTokenRequest.Builder
to create a
request.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.
This is a convenience which creates an instance of the ChangePasswordRequest.Builder
avoiding the need to
create one manually via ChangePasswordRequest.builder()
changePasswordRequest
- A Consumer
that will call methods on ChangePasswordRequest.Builder
to create a request.
Represents the request to change a user password.default CompletableFuture<ConfirmDeviceResponse> confirmDevice(ConfirmDeviceRequest confirmDeviceRequest)
Confirms tracking of the device. This API call is the call that begins device tracking.
confirmDeviceRequest
- Confirms the device request.default CompletableFuture<ConfirmDeviceResponse> confirmDevice(Consumer<ConfirmDeviceRequest.Builder> confirmDeviceRequest)
Confirms tracking of the device. This API call is the call that begins device tracking.
This is a convenience which creates an instance of the ConfirmDeviceRequest.Builder
avoiding the need to
create one manually via ConfirmDeviceRequest.builder()
confirmDeviceRequest
- A Consumer
that will call methods on ConfirmDeviceRequest.Builder
to create a request.
Confirms the device request.default CompletableFuture<ConfirmForgotPasswordResponse> confirmForgotPassword(ConfirmForgotPasswordRequest confirmForgotPasswordRequest)
Allows a user to enter a confirmation code to reset a forgotten password.
confirmForgotPasswordRequest
- The request representing the confirmation for a password reset.default CompletableFuture<ConfirmForgotPasswordResponse> confirmForgotPassword(Consumer<ConfirmForgotPasswordRequest.Builder> confirmForgotPasswordRequest)
Allows a user to enter a confirmation code to reset a forgotten password.
This is a convenience which creates an instance of the ConfirmForgotPasswordRequest.Builder
avoiding the
need to create one manually via ConfirmForgotPasswordRequest.builder()
confirmForgotPasswordRequest
- A Consumer
that will call methods on ConfirmForgotPasswordRequest.Builder
to create a
request. The request representing the confirmation for a password reset.default CompletableFuture<ConfirmSignUpResponse> confirmSignUp(ConfirmSignUpRequest confirmSignUpRequest)
Confirms registration of a user and handles the existing alias from a previous user.
confirmSignUpRequest
- Represents the request to confirm registration of a user.default CompletableFuture<ConfirmSignUpResponse> confirmSignUp(Consumer<ConfirmSignUpRequest.Builder> confirmSignUpRequest)
Confirms registration of a user and handles the existing alias from a previous user.
This is a convenience which creates an instance of the ConfirmSignUpRequest.Builder
avoiding the need to
create one manually via ConfirmSignUpRequest.builder()
confirmSignUpRequest
- A Consumer
that will call methods on ConfirmSignUpRequest.Builder
to create a request.
Represents the request to confirm registration of a user.default CompletableFuture<CreateGroupResponse> createGroup(CreateGroupRequest createGroupRequest)
Creates a new group in the specified user pool.
Calling this action requires developer credentials.
createGroupRequest
- default CompletableFuture<CreateGroupResponse> createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest)
Creates a new group in the specified user pool.
Calling this action requires developer credentials.
This is a convenience which creates an instance of the CreateGroupRequest.Builder
avoiding the need to
create one manually via CreateGroupRequest.builder()
createGroupRequest
- A Consumer
that will call methods on CreateGroupRequest.Builder
to create a request.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.
This is a convenience which creates an instance of the CreateIdentityProviderRequest.Builder
avoiding the
need to create one manually via CreateIdentityProviderRequest.builder()
createIdentityProviderRequest
- A Consumer
that will call methods on CreateIdentityProviderRequest.Builder
to create a
request.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.
This is a convenience which creates an instance of the CreateResourceServerRequest.Builder
avoiding the
need to create one manually via CreateResourceServerRequest.builder()
createResourceServerRequest
- A Consumer
that will call methods on CreateResourceServerRequest.Builder
to create a
request.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.
This is a convenience which creates an instance of the CreateUserImportJobRequest.Builder
avoiding the
need to create one manually via CreateUserImportJobRequest.builder()
createUserImportJobRequest
- A Consumer
that will call methods on CreateUserImportJobRequest.Builder
to create a
request. Represents the request to create the user import job.default CompletableFuture<CreateUserPoolResponse> createUserPool(CreateUserPoolRequest createUserPoolRequest)
Creates a new Amazon Cognito user pool and sets the password policy for the pool.
createUserPoolRequest
- Represents the request to create a user pool.default CompletableFuture<CreateUserPoolResponse> createUserPool(Consumer<CreateUserPoolRequest.Builder> createUserPoolRequest)
Creates a new Amazon Cognito user pool and sets the password policy for the pool.
This is a convenience which creates an instance of the CreateUserPoolRequest.Builder
avoiding the need to
create one manually via CreateUserPoolRequest.builder()
createUserPoolRequest
- A Consumer
that will call methods on CreateUserPoolRequest.Builder
to create a request.
Represents the request to create a user pool.default CompletableFuture<CreateUserPoolClientResponse> createUserPoolClient(CreateUserPoolClientRequest createUserPoolClientRequest)
Creates the user pool client.
createUserPoolClientRequest
- Represents the request to create a user pool client.default CompletableFuture<CreateUserPoolClientResponse> createUserPoolClient(Consumer<CreateUserPoolClientRequest.Builder> createUserPoolClientRequest)
Creates the user pool client.
This is a convenience which creates an instance of the CreateUserPoolClientRequest.Builder
avoiding the
need to create one manually via CreateUserPoolClientRequest.builder()
createUserPoolClientRequest
- A Consumer
that will call methods on CreateUserPoolClientRequest.Builder
to create a
request. Represents the request to create a user pool client.default CompletableFuture<CreateUserPoolDomainResponse> createUserPoolDomain(CreateUserPoolDomainRequest createUserPoolDomainRequest)
Creates a new domain for a user pool.
createUserPoolDomainRequest
- default CompletableFuture<CreateUserPoolDomainResponse> createUserPoolDomain(Consumer<CreateUserPoolDomainRequest.Builder> createUserPoolDomainRequest)
Creates a new domain for a user pool.
This is a convenience which creates an instance of the CreateUserPoolDomainRequest.Builder
avoiding the
need to create one manually via CreateUserPoolDomainRequest.builder()
createUserPoolDomainRequest
- A Consumer
that will call methods on CreateUserPoolDomainRequest.Builder
to create a
request.default CompletableFuture<DeleteGroupResponse> deleteGroup(DeleteGroupRequest deleteGroupRequest)
Deletes a group. Currently only groups with no members can be deleted.
Calling this action requires developer credentials.
deleteGroupRequest
- default CompletableFuture<DeleteGroupResponse> deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)
Deletes a group. Currently only groups with no members can be deleted.
Calling this action requires developer credentials.
This is a convenience which creates an instance of the DeleteGroupRequest.Builder
avoiding the need to
create one manually via DeleteGroupRequest.builder()
deleteGroupRequest
- A Consumer
that will call methods on DeleteGroupRequest.Builder
to create a request.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.
This is a convenience which creates an instance of the DeleteIdentityProviderRequest.Builder
avoiding the
need to create one manually via DeleteIdentityProviderRequest.builder()
deleteIdentityProviderRequest
- A Consumer
that will call methods on DeleteIdentityProviderRequest.Builder
to create a
request.default CompletableFuture<DeleteResourceServerResponse> deleteResourceServer(DeleteResourceServerRequest deleteResourceServerRequest)
Deletes a resource server.
deleteResourceServerRequest
- default CompletableFuture<DeleteResourceServerResponse> deleteResourceServer(Consumer<DeleteResourceServerRequest.Builder> deleteResourceServerRequest)
Deletes a resource server.
This is a convenience which creates an instance of the DeleteResourceServerRequest.Builder
avoiding the
need to create one manually via DeleteResourceServerRequest.builder()
deleteResourceServerRequest
- A Consumer
that will call methods on DeleteResourceServerRequest.Builder
to create a
request.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.
This is a convenience which creates an instance of the DeleteUserRequest.Builder
avoiding the need to
create one manually via DeleteUserRequest.builder()
deleteUserRequest
- A Consumer
that will call methods on DeleteUserRequest.Builder
to create a request.
Represents the request to delete a user.default CompletableFuture<DeleteUserAttributesResponse> deleteUserAttributes(DeleteUserAttributesRequest deleteUserAttributesRequest)
Deletes the attributes for a user.
deleteUserAttributesRequest
- Represents the request to delete user attributes.default CompletableFuture<DeleteUserAttributesResponse> deleteUserAttributes(Consumer<DeleteUserAttributesRequest.Builder> deleteUserAttributesRequest)
Deletes the attributes for a user.
This is a convenience which creates an instance of the DeleteUserAttributesRequest.Builder
avoiding the
need to create one manually via DeleteUserAttributesRequest.builder()
deleteUserAttributesRequest
- A Consumer
that will call methods on DeleteUserAttributesRequest.Builder
to create a
request. Represents the request to delete user attributes.default CompletableFuture<DeleteUserPoolResponse> deleteUserPool(DeleteUserPoolRequest deleteUserPoolRequest)
Deletes the specified Amazon Cognito user pool.
deleteUserPoolRequest
- Represents the request to delete a user pool.default CompletableFuture<DeleteUserPoolResponse> deleteUserPool(Consumer<DeleteUserPoolRequest.Builder> deleteUserPoolRequest)
Deletes the specified Amazon Cognito user pool.
This is a convenience which creates an instance of the DeleteUserPoolRequest.Builder
avoiding the need to
create one manually via DeleteUserPoolRequest.builder()
deleteUserPoolRequest
- A Consumer
that will call methods on DeleteUserPoolRequest.Builder
to create a request.
Represents the request to delete a user pool.default CompletableFuture<DeleteUserPoolClientResponse> deleteUserPoolClient(DeleteUserPoolClientRequest deleteUserPoolClientRequest)
Allows the developer to delete the user pool client.
deleteUserPoolClientRequest
- Represents the request to delete a user pool client.default CompletableFuture<DeleteUserPoolClientResponse> deleteUserPoolClient(Consumer<DeleteUserPoolClientRequest.Builder> deleteUserPoolClientRequest)
Allows the developer to delete the user pool client.
This is a convenience which creates an instance of the DeleteUserPoolClientRequest.Builder
avoiding the
need to create one manually via DeleteUserPoolClientRequest.builder()
deleteUserPoolClientRequest
- A Consumer
that will call methods on DeleteUserPoolClientRequest.Builder
to create a
request. Represents the request to delete a user pool client.default CompletableFuture<DeleteUserPoolDomainResponse> deleteUserPoolDomain(DeleteUserPoolDomainRequest deleteUserPoolDomainRequest)
Deletes a domain for a user pool.
deleteUserPoolDomainRequest
- default CompletableFuture<DeleteUserPoolDomainResponse> deleteUserPoolDomain(Consumer<DeleteUserPoolDomainRequest.Builder> deleteUserPoolDomainRequest)
Deletes a domain for a user pool.
This is a convenience which creates an instance of the DeleteUserPoolDomainRequest.Builder
avoiding the
need to create one manually via DeleteUserPoolDomainRequest.builder()
deleteUserPoolDomainRequest
- A Consumer
that will call methods on DeleteUserPoolDomainRequest.Builder
to create a
request.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.
This is a convenience which creates an instance of the DescribeIdentityProviderRequest.Builder
avoiding
the need to create one manually via DescribeIdentityProviderRequest.builder()
describeIdentityProviderRequest
- A Consumer
that will call methods on DescribeIdentityProviderRequest.Builder
to create a
request.default CompletableFuture<DescribeResourceServerResponse> describeResourceServer(DescribeResourceServerRequest describeResourceServerRequest)
Describes a resource server.
describeResourceServerRequest
- default CompletableFuture<DescribeResourceServerResponse> describeResourceServer(Consumer<DescribeResourceServerRequest.Builder> describeResourceServerRequest)
Describes a resource server.
This is a convenience which creates an instance of the DescribeResourceServerRequest.Builder
avoiding the
need to create one manually via DescribeResourceServerRequest.builder()
describeResourceServerRequest
- A Consumer
that will call methods on DescribeResourceServerRequest.Builder
to create a
request.default CompletableFuture<DescribeRiskConfigurationResponse> describeRiskConfiguration(DescribeRiskConfigurationRequest describeRiskConfigurationRequest)
Describes the risk configuration.
describeRiskConfigurationRequest
- default CompletableFuture<DescribeRiskConfigurationResponse> describeRiskConfiguration(Consumer<DescribeRiskConfigurationRequest.Builder> describeRiskConfigurationRequest)
Describes the risk configuration.
This is a convenience which creates an instance of the DescribeRiskConfigurationRequest.Builder
avoiding
the need to create one manually via DescribeRiskConfigurationRequest.builder()
describeRiskConfigurationRequest
- A Consumer
that will call methods on DescribeRiskConfigurationRequest.Builder
to create a
request.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.
This is a convenience which creates an instance of the DescribeUserImportJobRequest.Builder
avoiding the
need to create one manually via DescribeUserImportJobRequest.builder()
describeUserImportJobRequest
- A Consumer
that will call methods on DescribeUserImportJobRequest.Builder
to create a
request. Represents the request to describe the user import job.default CompletableFuture<DescribeUserPoolResponse> describeUserPool(DescribeUserPoolRequest describeUserPoolRequest)
Returns the configuration information and metadata of the specified user pool.
describeUserPoolRequest
- Represents the request to describe the user pool.default CompletableFuture<DescribeUserPoolResponse> describeUserPool(Consumer<DescribeUserPoolRequest.Builder> describeUserPoolRequest)
Returns the configuration information and metadata of the specified user pool.
This is a convenience which creates an instance of the DescribeUserPoolRequest.Builder
avoiding the need
to create one manually via DescribeUserPoolRequest.builder()
describeUserPoolRequest
- A Consumer
that will call methods on DescribeUserPoolRequest.Builder
to create a request.
Represents the request to describe the user pool.default CompletableFuture<DescribeUserPoolClientResponse> describeUserPoolClient(DescribeUserPoolClientRequest describeUserPoolClientRequest)
Client method for returning the configuration information and metadata of the specified user pool app 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 app client.
This is a convenience which creates an instance of the DescribeUserPoolClientRequest.Builder
avoiding the
need to create one manually via DescribeUserPoolClientRequest.builder()
describeUserPoolClientRequest
- A Consumer
that will call methods on DescribeUserPoolClientRequest.Builder
to create a
request. Represents the request to describe a user pool client.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.
This is a convenience which creates an instance of the DescribeUserPoolDomainRequest.Builder
avoiding the
need to create one manually via DescribeUserPoolDomainRequest.builder()
describeUserPoolDomainRequest
- A Consumer
that will call methods on DescribeUserPoolDomainRequest.Builder
to create a
request.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.
This is a convenience which creates an instance of the ForgetDeviceRequest.Builder
avoiding the need to
create one manually via ForgetDeviceRequest.builder()
forgetDeviceRequest
- A Consumer
that will call methods on ForgetDeviceRequest.Builder
to create a request.
Represents the request to forget the device.default CompletableFuture<ForgotPasswordResponse> forgotPassword(ForgotPasswordRequest forgotPasswordRequest)
Calling this API causes a message to be sent to the end user with a confirmation code that is required to change
the user's password. For the Username
parameter, you can use the username or user alias. The method
used to send the confirmation code is sent according to the specified AccountRecoverySetting. For more
information, see Recovering
User Accounts in the Amazon Cognito Developer Guide. If neither a verified phone number nor a verified
email exists, an 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. The method
used to send the confirmation code is sent according to the specified AccountRecoverySetting. For more
information, see Recovering
User Accounts in the Amazon Cognito Developer Guide. If neither a verified phone number nor a verified
email exists, an InvalidParameterException
is thrown. To use the confirmation code for resetting the
password, call ConfirmForgotPassword.
This is a convenience which creates an instance of the ForgotPasswordRequest.Builder
avoiding the need to
create one manually via ForgotPasswordRequest.builder()
forgotPasswordRequest
- A Consumer
that will call methods on ForgotPasswordRequest.Builder
to create a request.
Represents the request to reset a user's password.default CompletableFuture<GetCsvHeaderResponse> getCSVHeader(GetCsvHeaderRequest getCsvHeaderRequest)
Gets the header information for the .csv file to be used as input for the user import job.
getCsvHeaderRequest
- Represents the request to get the header information for the .csv file for the user import job.default CompletableFuture<GetCsvHeaderResponse> getCSVHeader(Consumer<GetCsvHeaderRequest.Builder> getCsvHeaderRequest)
Gets the header information for the .csv file to be used as input for the user import job.
This is a convenience which creates an instance of the GetCsvHeaderRequest.Builder
avoiding the need to
create one manually via GetCsvHeaderRequest.builder()
getCsvHeaderRequest
- A Consumer
that will call methods on GetCSVHeaderRequest.Builder
to create a request.
Represents the request to get the header information for the .csv file for the user import job.default CompletableFuture<GetDeviceResponse> getDevice(GetDeviceRequest getDeviceRequest)
Gets the device.
getDeviceRequest
- Represents the request to get the device.default CompletableFuture<GetDeviceResponse> getDevice(Consumer<GetDeviceRequest.Builder> getDeviceRequest)
Gets the device.
This is a convenience which creates an instance of the GetDeviceRequest.Builder
avoiding the need to
create one manually via GetDeviceRequest.builder()
getDeviceRequest
- A Consumer
that will call methods on GetDeviceRequest.Builder
to create a request.
Represents the request to get the device.default CompletableFuture<GetGroupResponse> getGroup(GetGroupRequest getGroupRequest)
Gets a group.
Calling this action requires developer credentials.
getGroupRequest
- default CompletableFuture<GetGroupResponse> getGroup(Consumer<GetGroupRequest.Builder> getGroupRequest)
Gets a group.
Calling this action requires developer credentials.
This is a convenience which creates an instance of the GetGroupRequest.Builder
avoiding the need to
create one manually via GetGroupRequest.builder()
getGroupRequest
- A Consumer
that will call methods on GetGroupRequest.Builder
to create a request.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.
This is a convenience which creates an instance of the GetIdentityProviderByIdentifierRequest.Builder
avoiding the need to create one manually via GetIdentityProviderByIdentifierRequest.builder()
getIdentityProviderByIdentifierRequest
- A Consumer
that will call methods on GetIdentityProviderByIdentifierRequest.Builder
to
create a request.default CompletableFuture<GetSigningCertificateResponse> getSigningCertificate(GetSigningCertificateRequest getSigningCertificateRequest)
This method takes a user pool ID, and returns the signing certificate.
getSigningCertificateRequest
- Request to get a signing certificate from Cognito.default CompletableFuture<GetSigningCertificateResponse> getSigningCertificate(Consumer<GetSigningCertificateRequest.Builder> getSigningCertificateRequest)
This method takes a user pool ID, and returns the signing certificate.
This is a convenience which creates an instance of the GetSigningCertificateRequest.Builder
avoiding the
need to create one manually via GetSigningCertificateRequest.builder()
getSigningCertificateRequest
- A Consumer
that will call methods on GetSigningCertificateRequest.Builder
to create a
request. Request to get a signing certificate from Cognito.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.
This is a convenience which creates an instance of the GetUiCustomizationRequest.Builder
avoiding the
need to create one manually via GetUiCustomizationRequest.builder()
getUiCustomizationRequest
- A Consumer
that will call methods on GetUICustomizationRequest.Builder
to create a
request.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.
This is a convenience which creates an instance of the GetUserRequest.Builder
avoiding the need to create
one manually via GetUserRequest.builder()
getUserRequest
- A Consumer
that will call methods on GetUserRequest.Builder
to create a request.
Represents the request to get information about the user.default CompletableFuture<GetUserAttributeVerificationCodeResponse> getUserAttributeVerificationCode(GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest)
Gets the user attribute verification code for the specified attribute name.
getUserAttributeVerificationCodeRequest
- Represents the request to get user attribute verification.default CompletableFuture<GetUserAttributeVerificationCodeResponse> getUserAttributeVerificationCode(Consumer<GetUserAttributeVerificationCodeRequest.Builder> getUserAttributeVerificationCodeRequest)
Gets the user attribute verification code for the specified attribute name.
This is a convenience which creates an instance of the GetUserAttributeVerificationCodeRequest.Builder
avoiding the need to create one manually via GetUserAttributeVerificationCodeRequest.builder()
getUserAttributeVerificationCodeRequest
- A Consumer
that will call methods on GetUserAttributeVerificationCodeRequest.Builder
to
create a request. Represents the request to get user attribute verification.default CompletableFuture<GetUserPoolMfaConfigResponse> getUserPoolMfaConfig(GetUserPoolMfaConfigRequest getUserPoolMfaConfigRequest)
Gets the user pool multi-factor authentication (MFA) configuration.
getUserPoolMfaConfigRequest
- default CompletableFuture<GetUserPoolMfaConfigResponse> getUserPoolMfaConfig(Consumer<GetUserPoolMfaConfigRequest.Builder> getUserPoolMfaConfigRequest)
Gets the user pool multi-factor authentication (MFA) configuration.
This is a convenience which creates an instance of the GetUserPoolMfaConfigRequest.Builder
avoiding the
need to create one manually via GetUserPoolMfaConfigRequest.builder()
getUserPoolMfaConfigRequest
- A Consumer
that will call methods on GetUserPoolMfaConfigRequest.Builder
to create a
request.default CompletableFuture<GlobalSignOutResponse> globalSignOut(GlobalSignOutRequest globalSignOutRequest)
Signs out users from all devices. It also invalidates all refresh tokens issued to a user. The user's current access and Id tokens remain valid until their expiry. Access and Id tokens expire one hour after they are issued.
globalSignOutRequest
- Represents the request to sign out all devices.default CompletableFuture<GlobalSignOutResponse> globalSignOut(Consumer<GlobalSignOutRequest.Builder> globalSignOutRequest)
Signs out users from all devices. It also invalidates all refresh tokens issued to a user. The user's current access and Id tokens remain valid until their expiry. Access and Id tokens expire one hour after they are issued.
This is a convenience which creates an instance of the GlobalSignOutRequest.Builder
avoiding the need to
create one manually via GlobalSignOutRequest.builder()
globalSignOutRequest
- A Consumer
that will call methods on GlobalSignOutRequest.Builder
to create a request.
Represents the request to sign out all devices.default CompletableFuture<InitiateAuthResponse> initiateAuth(InitiateAuthRequest initiateAuthRequest)
Initiates the authentication flow.
initiateAuthRequest
- Initiates the authentication request.default CompletableFuture<InitiateAuthResponse> initiateAuth(Consumer<InitiateAuthRequest.Builder> initiateAuthRequest)
Initiates the authentication flow.
This is a convenience which creates an instance of the InitiateAuthRequest.Builder
avoiding the need to
create one manually via InitiateAuthRequest.builder()
initiateAuthRequest
- A Consumer
that will call methods on InitiateAuthRequest.Builder
to create a request.
Initiates the authentication request.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.
This is a convenience which creates an instance of the ListDevicesRequest.Builder
avoiding the need to
create one manually via ListDevicesRequest.builder()
listDevicesRequest
- A Consumer
that will call methods on ListDevicesRequest.Builder
to create a request.
Represents the request to list the devices.default CompletableFuture<ListGroupsResponse> listGroups(ListGroupsRequest listGroupsRequest)
Lists the groups associated with a user pool.
Calling this action requires developer credentials.
listGroupsRequest
- default CompletableFuture<ListGroupsResponse> listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
Lists the groups associated with a user pool.
Calling this action requires developer credentials.
This is a convenience which creates an instance of the ListGroupsRequest.Builder
avoiding the need to
create one manually via ListGroupsRequest.builder()
listGroupsRequest
- A Consumer
that will call methods on ListGroupsRequest.Builder
to create a request.default ListGroupsPublisher listGroupsPaginator(ListGroupsRequest listGroupsRequest)
Lists the groups associated with a user pool.
Calling this action requires developer credentials.
This is a variant of
listGroups(software.amazon.awssdk.services.cognitoidentityprovider.model.ListGroupsRequest)
operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cognitoidentityprovider.model.ListGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cognitoidentityprovider.model.ListGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroups(software.amazon.awssdk.services.cognitoidentityprovider.model.ListGroupsRequest)
operation.
listGroupsRequest
- default ListGroupsPublisher listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
Lists the groups associated with a user pool.
Calling this action requires developer credentials.
This is a variant of
listGroups(software.amazon.awssdk.services.cognitoidentityprovider.model.ListGroupsRequest)
operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cognitoidentityprovider.model.ListGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cognitoidentityprovider.model.ListGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroups(software.amazon.awssdk.services.cognitoidentityprovider.model.ListGroupsRequest)
operation.
This is a convenience which creates an instance of the ListGroupsRequest.Builder
avoiding the need to
create one manually via ListGroupsRequest.builder()
listGroupsRequest
- A Consumer
that will call methods on ListGroupsRequest.Builder
to create a request.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.
This is a convenience which creates an instance of the ListIdentityProvidersRequest.Builder
avoiding the
need to create one manually via ListIdentityProvidersRequest.builder()
listIdentityProvidersRequest
- A Consumer
that will call methods on ListIdentityProvidersRequest.Builder
to create a
request.default ListIdentityProvidersPublisher listIdentityProvidersPaginator(ListIdentityProvidersRequest listIdentityProvidersRequest)
Lists information about all identity providers for a user pool.
This is a variant of
listIdentityProviders(software.amazon.awssdk.services.cognitoidentityprovider.model.ListIdentityProvidersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListIdentityProvidersPublisher publisher = client.listIdentityProvidersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListIdentityProvidersPublisher publisher = client.listIdentityProvidersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cognitoidentityprovider.model.ListIdentityProvidersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cognitoidentityprovider.model.ListIdentityProvidersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIdentityProviders(software.amazon.awssdk.services.cognitoidentityprovider.model.ListIdentityProvidersRequest)
operation.
listIdentityProvidersRequest
- default ListIdentityProvidersPublisher listIdentityProvidersPaginator(Consumer<ListIdentityProvidersRequest.Builder> listIdentityProvidersRequest)
Lists information about all identity providers for a user pool.
This is a variant of
listIdentityProviders(software.amazon.awssdk.services.cognitoidentityprovider.model.ListIdentityProvidersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListIdentityProvidersPublisher publisher = client.listIdentityProvidersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListIdentityProvidersPublisher publisher = client.listIdentityProvidersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cognitoidentityprovider.model.ListIdentityProvidersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cognitoidentityprovider.model.ListIdentityProvidersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIdentityProviders(software.amazon.awssdk.services.cognitoidentityprovider.model.ListIdentityProvidersRequest)
operation.
This is a convenience which creates an instance of the ListIdentityProvidersRequest.Builder
avoiding the
need to create one manually via ListIdentityProvidersRequest.builder()
listIdentityProvidersRequest
- A Consumer
that will call methods on ListIdentityProvidersRequest.Builder
to create a
request.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.
This is a convenience which creates an instance of the ListResourceServersRequest.Builder
avoiding the
need to create one manually via ListResourceServersRequest.builder()
listResourceServersRequest
- A Consumer
that will call methods on ListResourceServersRequest.Builder
to create a
request.default ListResourceServersPublisher listResourceServersPaginator(ListResourceServersRequest listResourceServersRequest)
Lists the resource servers for a user pool.
This is a variant of
listResourceServers(software.amazon.awssdk.services.cognitoidentityprovider.model.ListResourceServersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListResourceServersPublisher publisher = client.listResourceServersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListResourceServersPublisher publisher = client.listResourceServersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cognitoidentityprovider.model.ListResourceServersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cognitoidentityprovider.model.ListResourceServersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourceServers(software.amazon.awssdk.services.cognitoidentityprovider.model.ListResourceServersRequest)
operation.
listResourceServersRequest
- default ListResourceServersPublisher listResourceServersPaginator(Consumer<ListResourceServersRequest.Builder> listResourceServersRequest)
Lists the resource servers for a user pool.
This is a variant of
listResourceServers(software.amazon.awssdk.services.cognitoidentityprovider.model.ListResourceServersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListResourceServersPublisher publisher = client.listResourceServersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListResourceServersPublisher publisher = client.listResourceServersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cognitoidentityprovider.model.ListResourceServersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cognitoidentityprovider.model.ListResourceServersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourceServers(software.amazon.awssdk.services.cognitoidentityprovider.model.ListResourceServersRequest)
operation.
This is a convenience which creates an instance of the ListResourceServersRequest.Builder
avoiding the
need to create one manually via ListResourceServersRequest.builder()
listResourceServersRequest
- A Consumer
that will call methods on ListResourceServersRequest.Builder
to create a
request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags that are assigned to an Amazon Cognito user pool.
A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
You can use this action up to 10 times per second, per account.
listTagsForResourceRequest
- default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags that are assigned to an Amazon Cognito user pool.
A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
You can use this action up to 10 times per second, per account.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder
avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest
- A Consumer
that will call methods on ListTagsForResourceRequest.Builder
to create a
request.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.
This is a convenience which creates an instance of the ListUserImportJobsRequest.Builder
avoiding the
need to create one manually via ListUserImportJobsRequest.builder()
listUserImportJobsRequest
- A Consumer
that will call methods on ListUserImportJobsRequest.Builder
to create a
request. Represents the request to list the user import jobs.default CompletableFuture<ListUserPoolClientsResponse> listUserPoolClients(ListUserPoolClientsRequest listUserPoolClientsRequest)
Lists the clients that have been created for the specified user pool.
listUserPoolClientsRequest
- Represents the request to list the user pool clients.default CompletableFuture<ListUserPoolClientsResponse> listUserPoolClients(Consumer<ListUserPoolClientsRequest.Builder> listUserPoolClientsRequest)
Lists the clients that have been created for the specified user pool.
This is a convenience which creates an instance of the ListUserPoolClientsRequest.Builder
avoiding the
need to create one manually via ListUserPoolClientsRequest.builder()
listUserPoolClientsRequest
- A Consumer
that will call methods on ListUserPoolClientsRequest.Builder
to create a
request. Represents the request to list the user pool clients.default ListUserPoolClientsPublisher listUserPoolClientsPaginator(ListUserPoolClientsRequest listUserPoolClientsRequest)
Lists the clients that have been created for the specified user pool.
This is a variant of
listUserPoolClients(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUserPoolClientsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUserPoolClientsPublisher publisher = client.listUserPoolClientsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUserPoolClientsPublisher publisher = client.listUserPoolClientsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cognitoidentityprovider.model.ListUserPoolClientsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUserPoolClientsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUserPoolClients(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUserPoolClientsRequest)
operation.
listUserPoolClientsRequest
- Represents the request to list the user pool clients.default ListUserPoolClientsPublisher listUserPoolClientsPaginator(Consumer<ListUserPoolClientsRequest.Builder> listUserPoolClientsRequest)
Lists the clients that have been created for the specified user pool.
This is a variant of
listUserPoolClients(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUserPoolClientsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUserPoolClientsPublisher publisher = client.listUserPoolClientsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUserPoolClientsPublisher publisher = client.listUserPoolClientsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cognitoidentityprovider.model.ListUserPoolClientsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUserPoolClientsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUserPoolClients(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUserPoolClientsRequest)
operation.
This is a convenience which creates an instance of the ListUserPoolClientsRequest.Builder
avoiding the
need to create one manually via ListUserPoolClientsRequest.builder()
listUserPoolClientsRequest
- A Consumer
that will call methods on ListUserPoolClientsRequest.Builder
to create a
request. Represents the request to list the user pool clients.default CompletableFuture<ListUserPoolsResponse> listUserPools(ListUserPoolsRequest listUserPoolsRequest)
Lists the user pools associated with an AWS account.
listUserPoolsRequest
- Represents the request to list user pools.default CompletableFuture<ListUserPoolsResponse> listUserPools(Consumer<ListUserPoolsRequest.Builder> listUserPoolsRequest)
Lists the user pools associated with an AWS account.
This is a convenience which creates an instance of the ListUserPoolsRequest.Builder
avoiding the need to
create one manually via ListUserPoolsRequest.builder()
listUserPoolsRequest
- A Consumer
that will call methods on ListUserPoolsRequest.Builder
to create a request.
Represents the request to list user pools.default ListUserPoolsPublisher listUserPoolsPaginator(ListUserPoolsRequest listUserPoolsRequest)
Lists the user pools associated with an AWS account.
This is a variant of
listUserPools(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUserPoolsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUserPoolsPublisher publisher = client.listUserPoolsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUserPoolsPublisher publisher = client.listUserPoolsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cognitoidentityprovider.model.ListUserPoolsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUserPoolsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUserPools(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUserPoolsRequest)
operation.
listUserPoolsRequest
- Represents the request to list user pools.default ListUserPoolsPublisher listUserPoolsPaginator(Consumer<ListUserPoolsRequest.Builder> listUserPoolsRequest)
Lists the user pools associated with an AWS account.
This is a variant of
listUserPools(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUserPoolsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUserPoolsPublisher publisher = client.listUserPoolsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUserPoolsPublisher publisher = client.listUserPoolsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cognitoidentityprovider.model.ListUserPoolsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUserPoolsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUserPools(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUserPoolsRequest)
operation.
This is a convenience which creates an instance of the ListUserPoolsRequest.Builder
avoiding the need to
create one manually via ListUserPoolsRequest.builder()
listUserPoolsRequest
- A Consumer
that will call methods on ListUserPoolsRequest.Builder
to create a request.
Represents the request to list user pools.default CompletableFuture<ListUsersResponse> listUsers(ListUsersRequest listUsersRequest)
Lists the users in the Amazon Cognito user pool.
listUsersRequest
- Represents the request to list users.default CompletableFuture<ListUsersResponse> listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)
Lists the users in the Amazon Cognito user pool.
This is a convenience which creates an instance of the ListUsersRequest.Builder
avoiding the need to
create one manually via ListUsersRequest.builder()
listUsersRequest
- A Consumer
that will call methods on ListUsersRequest.Builder
to create a request.
Represents the request to list users.default CompletableFuture<ListUsersInGroupResponse> listUsersInGroup(ListUsersInGroupRequest listUsersInGroupRequest)
Lists the users in the specified group.
Calling this action requires developer credentials.
listUsersInGroupRequest
- default CompletableFuture<ListUsersInGroupResponse> listUsersInGroup(Consumer<ListUsersInGroupRequest.Builder> listUsersInGroupRequest)
Lists the users in the specified group.
Calling this action requires developer credentials.
This is a convenience which creates an instance of the ListUsersInGroupRequest.Builder
avoiding the need
to create one manually via ListUsersInGroupRequest.builder()
listUsersInGroupRequest
- A Consumer
that will call methods on ListUsersInGroupRequest.Builder
to create a request.default ListUsersInGroupPublisher listUsersInGroupPaginator(ListUsersInGroupRequest listUsersInGroupRequest)
Lists the users in the specified group.
Calling this action requires developer credentials.
This is a variant of
listUsersInGroup(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUsersInGroupRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUsersInGroupPublisher publisher = client.listUsersInGroupPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUsersInGroupPublisher publisher = client.listUsersInGroupPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cognitoidentityprovider.model.ListUsersInGroupResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUsersInGroupResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUsersInGroup(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUsersInGroupRequest)
operation.
listUsersInGroupRequest
- default ListUsersInGroupPublisher listUsersInGroupPaginator(Consumer<ListUsersInGroupRequest.Builder> listUsersInGroupRequest)
Lists the users in the specified group.
Calling this action requires developer credentials.
This is a variant of
listUsersInGroup(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUsersInGroupRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUsersInGroupPublisher publisher = client.listUsersInGroupPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUsersInGroupPublisher publisher = client.listUsersInGroupPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cognitoidentityprovider.model.ListUsersInGroupResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUsersInGroupResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUsersInGroup(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUsersInGroupRequest)
operation.
This is a convenience which creates an instance of the ListUsersInGroupRequest.Builder
avoiding the need
to create one manually via ListUsersInGroupRequest.builder()
listUsersInGroupRequest
- A Consumer
that will call methods on ListUsersInGroupRequest.Builder
to create a request.default ListUsersPublisher listUsersPaginator(ListUsersRequest listUsersRequest)
Lists the users in the Amazon Cognito user pool.
This is a variant of
listUsers(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUsersRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cognitoidentityprovider.model.ListUsersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUsersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUsersRequest)
operation.
listUsersRequest
- Represents the request to list users.default ListUsersPublisher listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest)
Lists the users in the Amazon Cognito user pool.
This is a variant of
listUsers(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUsersRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cognitoidentityprovider.model.ListUsersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUsersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUsersRequest)
operation.
This is a convenience which creates an instance of the ListUsersRequest.Builder
avoiding the need to
create one manually via ListUsersRequest.builder()
listUsersRequest
- A Consumer
that will call methods on ListUsersRequest.Builder
to create a request.
Represents the request to list users.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.
This is a convenience which creates an instance of the ResendConfirmationCodeRequest.Builder
avoiding the
need to create one manually via ResendConfirmationCodeRequest.builder()
resendConfirmationCodeRequest
- A Consumer
that will call methods on ResendConfirmationCodeRequest.Builder
to create a
request. Represents the request to resend the confirmation code.default CompletableFuture<RespondToAuthChallengeResponse> respondToAuthChallenge(RespondToAuthChallengeRequest respondToAuthChallengeRequest)
Responds to the authentication challenge.
respondToAuthChallengeRequest
- The request to respond to an authentication challenge.default CompletableFuture<RespondToAuthChallengeResponse> respondToAuthChallenge(Consumer<RespondToAuthChallengeRequest.Builder> respondToAuthChallengeRequest)
Responds to the authentication challenge.
This is a convenience which creates an instance of the RespondToAuthChallengeRequest.Builder
avoiding the
need to create one manually via RespondToAuthChallengeRequest.builder()
respondToAuthChallengeRequest
- A Consumer
that will call methods on RespondToAuthChallengeRequest.Builder
to create a
request. The request to respond to an authentication challenge.default CompletableFuture<SetRiskConfigurationResponse> setRiskConfiguration(SetRiskConfigurationRequest setRiskConfigurationRequest)
Configures actions on detected risks. To delete the risk configuration for UserPoolId
or
ClientId
, pass null values for all four configuration types.
To enable Amazon Cognito advanced security features, update the user pool to include the
UserPoolAddOns
keyAdvancedSecurityMode
.
setRiskConfigurationRequest
- default CompletableFuture<SetRiskConfigurationResponse> setRiskConfiguration(Consumer<SetRiskConfigurationRequest.Builder> setRiskConfigurationRequest)
Configures actions on detected risks. To delete the risk configuration for UserPoolId
or
ClientId
, pass null values for all four configuration types.
To enable Amazon Cognito advanced security features, update the user pool to include the
UserPoolAddOns
keyAdvancedSecurityMode
.
This is a convenience which creates an instance of the SetRiskConfigurationRequest.Builder
avoiding the
need to create one manually via SetRiskConfigurationRequest.builder()
setRiskConfigurationRequest
- A Consumer
that will call methods on SetRiskConfigurationRequest.Builder
to create a
request.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.
This is a convenience which creates an instance of the SetUiCustomizationRequest.Builder
avoiding the
need to create one manually via SetUiCustomizationRequest.builder()
setUiCustomizationRequest
- A Consumer
that will call methods on SetUICustomizationRequest.Builder
to create a
request.default CompletableFuture<SetUserMfaPreferenceResponse> setUserMFAPreference(SetUserMfaPreferenceRequest setUserMfaPreferenceRequest)
Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are enabled and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are enabled. If multiple options are enabled and no preference is set, a challenge to choose an MFA option will be returned during sign in.
setUserMfaPreferenceRequest
- default CompletableFuture<SetUserMfaPreferenceResponse> setUserMFAPreference(Consumer<SetUserMfaPreferenceRequest.Builder> setUserMfaPreferenceRequest)
Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are enabled and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are enabled. If multiple options are enabled and no preference is set, a challenge to choose an MFA option will be returned during sign in.
This is a convenience which creates an instance of the SetUserMfaPreferenceRequest.Builder
avoiding the
need to create one manually via SetUserMfaPreferenceRequest.builder()
setUserMfaPreferenceRequest
- A Consumer
that will call methods on SetUserMFAPreferenceRequest.Builder
to create a
request.default CompletableFuture<SetUserPoolMfaConfigResponse> setUserPoolMfaConfig(SetUserPoolMfaConfigRequest setUserPoolMfaConfigRequest)
Set the user pool multi-factor authentication (MFA) configuration.
setUserPoolMfaConfigRequest
- default CompletableFuture<SetUserPoolMfaConfigResponse> setUserPoolMfaConfig(Consumer<SetUserPoolMfaConfigRequest.Builder> setUserPoolMfaConfigRequest)
Set the user pool multi-factor authentication (MFA) configuration.
This is a convenience which creates an instance of the SetUserPoolMfaConfigRequest.Builder
avoiding the
need to create one manually via SetUserPoolMfaConfigRequest.builder()
setUserPoolMfaConfigRequest
- A Consumer
that will call methods on SetUserPoolMfaConfigRequest.Builder
to create a
request.default CompletableFuture<SetUserSettingsResponse> setUserSettings(SetUserSettingsRequest setUserSettingsRequest)
This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either type of MFA, use SetUserMFAPreference instead.
setUserSettingsRequest
- Represents the request to set user settings.default CompletableFuture<SetUserSettingsResponse> setUserSettings(Consumer<SetUserSettingsRequest.Builder> setUserSettingsRequest)
This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either type of MFA, use SetUserMFAPreference instead.
This is a convenience which creates an instance of the SetUserSettingsRequest.Builder
avoiding the need
to create one manually via SetUserSettingsRequest.builder()
setUserSettingsRequest
- A Consumer
that will call methods on SetUserSettingsRequest.Builder
to create a request.
Represents the request to set user settings.default CompletableFuture<SignUpResponse> signUp(SignUpRequest signUpRequest)
Registers the user in the specified user pool and creates a user name, password, and user attributes.
signUpRequest
- Represents the request to register a user.default CompletableFuture<SignUpResponse> signUp(Consumer<SignUpRequest.Builder> signUpRequest)
Registers the user in the specified user pool and creates a user name, password, and user attributes.
This is a convenience which creates an instance of the SignUpRequest.Builder
avoiding the need to create
one manually via SignUpRequest.builder()
signUpRequest
- A Consumer
that will call methods on SignUpRequest.Builder
to create a request. Represents
the request to register a user.default CompletableFuture<StartUserImportJobResponse> startUserImportJob(StartUserImportJobRequest startUserImportJobRequest)
Starts the user import.
startUserImportJobRequest
- Represents the request to start the user import job.default CompletableFuture<StartUserImportJobResponse> startUserImportJob(Consumer<StartUserImportJobRequest.Builder> startUserImportJobRequest)
Starts the user import.
This is a convenience which creates an instance of the StartUserImportJobRequest.Builder
avoiding the
need to create one manually via StartUserImportJobRequest.builder()
startUserImportJobRequest
- A Consumer
that will call methods on StartUserImportJobRequest.Builder
to create a
request. Represents the request to start the user import job.default CompletableFuture<StopUserImportJobResponse> stopUserImportJob(StopUserImportJobRequest stopUserImportJobRequest)
Stops the user import job.
stopUserImportJobRequest
- Represents the request to stop the user import job.default CompletableFuture<StopUserImportJobResponse> stopUserImportJob(Consumer<StopUserImportJobRequest.Builder> stopUserImportJobRequest)
Stops the user import job.
This is a convenience which creates an instance of the StopUserImportJobRequest.Builder
avoiding the need
to create one manually via StopUserImportJobRequest.builder()
stopUserImportJobRequest
- A Consumer
that will call methods on StopUserImportJobRequest.Builder
to create a request.
Represents the request to stop the user import job.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
Each tag consists of a key and value, both of which you define. A key is a general category for more specific
values. For example, if you have two versions of a user pool, one for testing and another for production, you
might assign an Environment
tag key to both user pools. The value of this key might be
Test
for one user pool and Production
for the other.
Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your user pools. In an IAM policy, you can constrain permissions for user pools based on specific tags or tag values.
You can use this action up to 5 times per second, per account. A user pool can have as many as 50 tags.
tagResourceRequest
- default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
Each tag consists of a key and value, both of which you define. A key is a general category for more specific
values. For example, if you have two versions of a user pool, one for testing and another for production, you
might assign an Environment
tag key to both user pools. The value of this key might be
Test
for one user pool and Production
for the other.
Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your user pools. In an IAM policy, you can constrain permissions for user pools based on specific tags or tag values.
You can use this action up to 5 times per second, per account. A user pool can have as many as 50 tags.
This is a convenience which creates an instance of the TagResourceRequest.Builder
avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest
- A Consumer
that will call methods on TagResourceRequest.Builder
to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account
untagResourceRequest
- default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account
This is a convenience which creates an instance of the UntagResourceRequest.Builder
avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest
- A Consumer
that will call methods on UntagResourceRequest.Builder
to create a request.default CompletableFuture<UpdateAuthEventFeedbackResponse> updateAuthEventFeedback(UpdateAuthEventFeedbackRequest updateAuthEventFeedbackRequest)
Provides the feedback for an authentication event whether it was from a valid user or not. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.
updateAuthEventFeedbackRequest
- default CompletableFuture<UpdateAuthEventFeedbackResponse> updateAuthEventFeedback(Consumer<UpdateAuthEventFeedbackRequest.Builder> updateAuthEventFeedbackRequest)
Provides the feedback for an authentication event whether it was from a valid user or not. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.
This is a convenience which creates an instance of the UpdateAuthEventFeedbackRequest.Builder
avoiding
the need to create one manually via UpdateAuthEventFeedbackRequest.builder()
updateAuthEventFeedbackRequest
- A Consumer
that will call methods on UpdateAuthEventFeedbackRequest.Builder
to create a
request.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.
This is a convenience which creates an instance of the UpdateDeviceStatusRequest.Builder
avoiding the
need to create one manually via UpdateDeviceStatusRequest.builder()
updateDeviceStatusRequest
- A Consumer
that will call methods on UpdateDeviceStatusRequest.Builder
to create a
request. Represents the request to update the device status.default CompletableFuture<UpdateGroupResponse> updateGroup(UpdateGroupRequest updateGroupRequest)
Updates the specified group with the specified attributes.
Calling this action requires developer credentials.
If you don't provide a value for an attribute, it will be set to the default value.
updateGroupRequest
- default CompletableFuture<UpdateGroupResponse> updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest)
Updates the specified group with the specified attributes.
Calling this action requires developer credentials.
If you don't provide a value for an attribute, it will be set to the default value.
This is a convenience which creates an instance of the UpdateGroupRequest.Builder
avoiding the need to
create one manually via UpdateGroupRequest.builder()
updateGroupRequest
- A Consumer
that will call methods on UpdateGroupRequest.Builder
to create a request.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.
This is a convenience which creates an instance of the UpdateIdentityProviderRequest.Builder
avoiding the
need to create one manually via UpdateIdentityProviderRequest.builder()
updateIdentityProviderRequest
- A Consumer
that will call methods on UpdateIdentityProviderRequest.Builder
to create a
request.default CompletableFuture<UpdateResourceServerResponse> updateResourceServer(UpdateResourceServerRequest updateResourceServerRequest)
Updates the name and scopes of resource server. All other fields are read-only.
If you don't provide a value for an attribute, it will be set to the default value.
updateResourceServerRequest
- default CompletableFuture<UpdateResourceServerResponse> updateResourceServer(Consumer<UpdateResourceServerRequest.Builder> updateResourceServerRequest)
Updates the name and scopes of resource server. All other fields are read-only.
If you don't provide a value for an attribute, it will be set to the default value.
This is a convenience which creates an instance of the UpdateResourceServerRequest.Builder
avoiding the
need to create one manually via UpdateResourceServerRequest.builder()
updateResourceServerRequest
- A Consumer
that will call methods on UpdateResourceServerRequest.Builder
to create a
request.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).
This is a convenience which creates an instance of the UpdateUserAttributesRequest.Builder
avoiding the
need to create one manually via UpdateUserAttributesRequest.builder()
updateUserAttributesRequest
- A Consumer
that will call methods on UpdateUserAttributesRequest.Builder
to create a
request. Represents the request to update user attributes.default CompletableFuture<UpdateUserPoolResponse> updateUserPool(UpdateUserPoolRequest updateUserPoolRequest)
Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings using DescribeUserPool.
If you don't provide a value for an attribute, it will be set to the default value.
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. You can get a list of the current user pool settings using DescribeUserPool.
If you don't provide a value for an attribute, it will be set to the default value.
This is a convenience which creates an instance of the UpdateUserPoolRequest.Builder
avoiding the need to
create one manually via UpdateUserPoolRequest.builder()
updateUserPoolRequest
- A Consumer
that will call methods on UpdateUserPoolRequest.Builder
to create a request.
Represents the request to update the user pool.default CompletableFuture<UpdateUserPoolClientResponse> updateUserPoolClient(UpdateUserPoolClientRequest updateUserPoolClientRequest)
Updates the specified user pool app client with the specified attributes. You can get a list of the current user pool app client settings using DescribeUserPoolClient.
If you don't provide a value for an attribute, it will be set to the default value.
updateUserPoolClientRequest
- Represents the request to update the user pool client.default CompletableFuture<UpdateUserPoolClientResponse> updateUserPoolClient(Consumer<UpdateUserPoolClientRequest.Builder> updateUserPoolClientRequest)
Updates the specified user pool app client with the specified attributes. You can get a list of the current user pool app client settings using DescribeUserPoolClient.
If you don't provide a value for an attribute, it will be set to the default value.
This is a convenience which creates an instance of the UpdateUserPoolClientRequest.Builder
avoiding the
need to create one manually via UpdateUserPoolClientRequest.builder()
updateUserPoolClientRequest
- A Consumer
that will call methods on UpdateUserPoolClientRequest.Builder
to create a
request. Represents the request to update the user pool client.default CompletableFuture<UpdateUserPoolDomainResponse> updateUserPoolDomain(UpdateUserPoolDomainRequest updateUserPoolDomainRequest)
Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.
You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You cannot use it to change the domain for a user pool.
A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and sign-in pages for your application. When you set up a custom domain, you provide a certificate that you manage with AWS Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain.
Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same, and your custom domain uses the new certificate automatically.
However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide this ARN to Amazon Cognito.
When you add your new certificate in ACM, you must choose US East (N. Virginia) as the AWS Region.
After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain.
For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
updateUserPoolDomainRequest
- The UpdateUserPoolDomain request input.default CompletableFuture<UpdateUserPoolDomainResponse> updateUserPoolDomain(Consumer<UpdateUserPoolDomainRequest.Builder> updateUserPoolDomainRequest)
Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.
You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You cannot use it to change the domain for a user pool.
A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and sign-in pages for your application. When you set up a custom domain, you provide a certificate that you manage with AWS Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain.
Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same, and your custom domain uses the new certificate automatically.
However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide this ARN to Amazon Cognito.
When you add your new certificate in ACM, you must choose US East (N. Virginia) as the AWS Region.
After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain.
For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
This is a convenience which creates an instance of the UpdateUserPoolDomainRequest.Builder
avoiding the
need to create one manually via UpdateUserPoolDomainRequest.builder()
updateUserPoolDomainRequest
- A Consumer
that will call methods on UpdateUserPoolDomainRequest.Builder
to create a
request. The UpdateUserPoolDomain request input.default CompletableFuture<VerifySoftwareTokenResponse> verifySoftwareToken(VerifySoftwareTokenRequest verifySoftwareTokenRequest)
Use this API to register a user's entered TOTP code and mark the user's software token MFA status as "verified" if successful. The request takes an access token or a session string, but not both.
verifySoftwareTokenRequest
- default CompletableFuture<VerifySoftwareTokenResponse> verifySoftwareToken(Consumer<VerifySoftwareTokenRequest.Builder> verifySoftwareTokenRequest)
Use this API to register a user's entered TOTP code and mark the user's software token MFA status as "verified" if successful. The request takes an access token or a session string, but not both.
This is a convenience which creates an instance of the VerifySoftwareTokenRequest.Builder
avoiding the
need to create one manually via VerifySoftwareTokenRequest.builder()
verifySoftwareTokenRequest
- A Consumer
that will call methods on VerifySoftwareTokenRequest.Builder
to create a
request.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.
This is a convenience which creates an instance of the VerifyUserAttributeRequest.Builder
avoiding the
need to create one manually via VerifyUserAttributeRequest.builder()
verifyUserAttributeRequest
- A Consumer
that will call methods on VerifyUserAttributeRequest.Builder
to create a
request. Represents the request to verify user attributes.Copyright © 2020. All rights reserved.