@Generated(value="software.amazon.awssdk:codegen") public interface CognitoIdentityProviderClient 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_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider . |
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default AddCustomAttributesResponse |
addCustomAttributes(AddCustomAttributesRequest addCustomAttributesRequest)
Adds additional user attributes to the user pool schema.
|
default AddCustomAttributesResponse |
addCustomAttributes(Consumer<AddCustomAttributesRequest.Builder> addCustomAttributesRequest)
Adds additional user attributes to the user pool schema.
|
default AdminAddUserToGroupResponse |
adminAddUserToGroup(AdminAddUserToGroupRequest adminAddUserToGroupRequest)
Adds the specified user to the specified group.
|
default AdminAddUserToGroupResponse |
adminAddUserToGroup(Consumer<AdminAddUserToGroupRequest.Builder> adminAddUserToGroupRequest)
Adds the specified user to the specified group.
|
default AdminConfirmSignUpResponse |
adminConfirmSignUp(AdminConfirmSignUpRequest adminConfirmSignUpRequest)
Confirms user registration as an admin without using a confirmation code.
|
default AdminConfirmSignUpResponse |
adminConfirmSignUp(Consumer<AdminConfirmSignUpRequest.Builder> adminConfirmSignUpRequest)
Confirms user registration as an admin without using a confirmation code.
|
default AdminCreateUserResponse |
adminCreateUser(AdminCreateUserRequest adminCreateUserRequest)
Creates a new user in the specified user pool.
|
default AdminCreateUserResponse |
adminCreateUser(Consumer<AdminCreateUserRequest.Builder> adminCreateUserRequest)
Creates a new user in the specified user pool.
|
default AdminDeleteUserResponse |
adminDeleteUser(AdminDeleteUserRequest adminDeleteUserRequest)
Deletes a user as an administrator.
|
default AdminDeleteUserResponse |
adminDeleteUser(Consumer<AdminDeleteUserRequest.Builder> adminDeleteUserRequest)
Deletes a user as an administrator.
|
default AdminDeleteUserAttributesResponse |
adminDeleteUserAttributes(AdminDeleteUserAttributesRequest adminDeleteUserAttributesRequest)
Deletes the user attributes in a user pool as an administrator.
|
default AdminDeleteUserAttributesResponse |
adminDeleteUserAttributes(Consumer<AdminDeleteUserAttributesRequest.Builder> adminDeleteUserAttributesRequest)
Deletes the user attributes in a user pool as an administrator.
|
default AdminDisableProviderForUserResponse |
adminDisableProviderForUser(AdminDisableProviderForUserRequest adminDisableProviderForUserRequest)
Disables the user from signing in with the specified external (SAML or social) identity provider.
|
default AdminDisableProviderForUserResponse |
adminDisableProviderForUser(Consumer<AdminDisableProviderForUserRequest.Builder> adminDisableProviderForUserRequest)
Disables the user from signing in with the specified external (SAML or social) identity provider.
|
default AdminDisableUserResponse |
adminDisableUser(AdminDisableUserRequest adminDisableUserRequest)
Disables the specified user.
|
default AdminDisableUserResponse |
adminDisableUser(Consumer<AdminDisableUserRequest.Builder> adminDisableUserRequest)
Disables the specified user.
|
default AdminEnableUserResponse |
adminEnableUser(AdminEnableUserRequest adminEnableUserRequest)
Enables the specified user as an administrator.
|
default AdminEnableUserResponse |
adminEnableUser(Consumer<AdminEnableUserRequest.Builder> adminEnableUserRequest)
Enables the specified user as an administrator.
|
default AdminForgetDeviceResponse |
adminForgetDevice(AdminForgetDeviceRequest adminForgetDeviceRequest)
Forgets the device, as an administrator.
|
default AdminForgetDeviceResponse |
adminForgetDevice(Consumer<AdminForgetDeviceRequest.Builder> adminForgetDeviceRequest)
Forgets the device, as an administrator.
|
default AdminGetDeviceResponse |
adminGetDevice(AdminGetDeviceRequest adminGetDeviceRequest)
Gets the device, as an administrator.
|
default AdminGetDeviceResponse |
adminGetDevice(Consumer<AdminGetDeviceRequest.Builder> adminGetDeviceRequest)
Gets the device, as an administrator.
|
default AdminGetUserResponse |
adminGetUser(AdminGetUserRequest adminGetUserRequest)
Gets the specified user by user name in a user pool as an administrator.
|
default AdminGetUserResponse |
adminGetUser(Consumer<AdminGetUserRequest.Builder> adminGetUserRequest)
Gets the specified user by user name in a user pool as an administrator.
|
default AdminInitiateAuthResponse |
adminInitiateAuth(AdminInitiateAuthRequest adminInitiateAuthRequest)
Initiates the authentication flow, as an administrator.
|
default AdminInitiateAuthResponse |
adminInitiateAuth(Consumer<AdminInitiateAuthRequest.Builder> adminInitiateAuthRequest)
Initiates the authentication flow, as an administrator.
|
default 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 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 AdminListDevicesResponse |
adminListDevices(AdminListDevicesRequest adminListDevicesRequest)
Lists devices, as an administrator.
|
default AdminListDevicesResponse |
adminListDevices(Consumer<AdminListDevicesRequest.Builder> adminListDevicesRequest)
Lists devices, as an administrator.
|
default AdminListGroupsForUserResponse |
adminListGroupsForUser(AdminListGroupsForUserRequest adminListGroupsForUserRequest)
Lists the groups that the user belongs to.
|
default AdminListGroupsForUserResponse |
adminListGroupsForUser(Consumer<AdminListGroupsForUserRequest.Builder> adminListGroupsForUserRequest)
Lists the groups that the user belongs to.
|
default AdminListGroupsForUserIterable |
adminListGroupsForUserPaginator(AdminListGroupsForUserRequest adminListGroupsForUserRequest)
Lists the groups that the user belongs to.
|
default AdminListGroupsForUserIterable |
adminListGroupsForUserPaginator(Consumer<AdminListGroupsForUserRequest.Builder> adminListGroupsForUserRequest)
Lists the groups that the user belongs to.
|
default AdminListUserAuthEventsResponse |
adminListUserAuthEvents(AdminListUserAuthEventsRequest adminListUserAuthEventsRequest)
Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security.
|
default AdminListUserAuthEventsResponse |
adminListUserAuthEvents(Consumer<AdminListUserAuthEventsRequest.Builder> adminListUserAuthEventsRequest)
Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security.
|
default AdminListUserAuthEventsIterable |
adminListUserAuthEventsPaginator(AdminListUserAuthEventsRequest adminListUserAuthEventsRequest)
Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security.
|
default AdminListUserAuthEventsIterable |
adminListUserAuthEventsPaginator(Consumer<AdminListUserAuthEventsRequest.Builder> adminListUserAuthEventsRequest)
Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security.
|
default AdminRemoveUserFromGroupResponse |
adminRemoveUserFromGroup(AdminRemoveUserFromGroupRequest adminRemoveUserFromGroupRequest)
Removes the specified user from the specified group.
|
default AdminRemoveUserFromGroupResponse |
adminRemoveUserFromGroup(Consumer<AdminRemoveUserFromGroupRequest.Builder> adminRemoveUserFromGroupRequest)
Removes the specified user from the specified group.
|
default AdminResetUserPasswordResponse |
adminResetUserPassword(AdminResetUserPasswordRequest adminResetUserPasswordRequest)
Resets the specified user's password in a user pool as an administrator.
|
default AdminResetUserPasswordResponse |
adminResetUserPassword(Consumer<AdminResetUserPasswordRequest.Builder> adminResetUserPasswordRequest)
Resets the specified user's password in a user pool as an administrator.
|
default AdminRespondToAuthChallengeResponse |
adminRespondToAuthChallenge(AdminRespondToAuthChallengeRequest adminRespondToAuthChallengeRequest)
Responds to an authentication challenge, as an administrator.
|
default AdminRespondToAuthChallengeResponse |
adminRespondToAuthChallenge(Consumer<AdminRespondToAuthChallengeRequest.Builder> adminRespondToAuthChallengeRequest)
Responds to an authentication challenge, as an administrator.
|
default 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 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 AdminSetUserPasswordResponse |
adminSetUserPassword(AdminSetUserPasswordRequest adminSetUserPasswordRequest)
Sets the specified user's password in a user pool as an administrator.
|
default AdminSetUserPasswordResponse |
adminSetUserPassword(Consumer<AdminSetUserPasswordRequest.Builder> adminSetUserPasswordRequest)
Sets the specified user's password in a user pool as an administrator.
|
default AdminSetUserSettingsResponse |
adminSetUserSettings(AdminSetUserSettingsRequest adminSetUserSettingsRequest)
This action is no longer supported. You can use it to configure only SMS MFA.
|
default AdminSetUserSettingsResponse |
adminSetUserSettings(Consumer<AdminSetUserSettingsRequest.Builder> adminSetUserSettingsRequest)
This action is no longer supported. You can use it to configure only SMS MFA.
|
default AdminUpdateAuthEventFeedbackResponse |
adminUpdateAuthEventFeedback(AdminUpdateAuthEventFeedbackRequest adminUpdateAuthEventFeedbackRequest)
Provides feedback for an authentication event as to whether it was from a valid user.
|
default AdminUpdateAuthEventFeedbackResponse |
adminUpdateAuthEventFeedback(Consumer<AdminUpdateAuthEventFeedbackRequest.Builder> adminUpdateAuthEventFeedbackRequest)
Provides feedback for an authentication event as to whether it was from a valid user.
|
default AdminUpdateDeviceStatusResponse |
adminUpdateDeviceStatus(AdminUpdateDeviceStatusRequest adminUpdateDeviceStatusRequest)
Updates the device status as an administrator.
|
default AdminUpdateDeviceStatusResponse |
adminUpdateDeviceStatus(Consumer<AdminUpdateDeviceStatusRequest.Builder> adminUpdateDeviceStatusRequest)
Updates the device status as an administrator.
|
default AdminUpdateUserAttributesResponse |
adminUpdateUserAttributes(AdminUpdateUserAttributesRequest adminUpdateUserAttributesRequest)
Updates the specified user's attributes, including developer attributes, as an administrator.
|
default AdminUpdateUserAttributesResponse |
adminUpdateUserAttributes(Consumer<AdminUpdateUserAttributesRequest.Builder> adminUpdateUserAttributesRequest)
Updates the specified user's attributes, including developer attributes, as an administrator.
|
default AdminUserGlobalSignOutResponse |
adminUserGlobalSignOut(AdminUserGlobalSignOutRequest adminUserGlobalSignOutRequest)
Signs out users from all devices, as an administrator.
|
default AdminUserGlobalSignOutResponse |
adminUserGlobalSignOut(Consumer<AdminUserGlobalSignOutRequest.Builder> adminUserGlobalSignOutRequest)
Signs out users from all devices, as an administrator.
|
default AssociateSoftwareTokenResponse |
associateSoftwareToken(AssociateSoftwareTokenRequest associateSoftwareTokenRequest)
Returns a unique generated shared secret key code for the user account.
|
default AssociateSoftwareTokenResponse |
associateSoftwareToken(Consumer<AssociateSoftwareTokenRequest.Builder> associateSoftwareTokenRequest)
Returns a unique generated shared secret key code for the user account.
|
static CognitoIdentityProviderClientBuilder |
builder()
Create a builder that can be used to configure and create a
CognitoIdentityProviderClient . |
default ChangePasswordResponse |
changePassword(ChangePasswordRequest changePasswordRequest)
Changes the password for a specified user in a user pool.
|
default ChangePasswordResponse |
changePassword(Consumer<ChangePasswordRequest.Builder> changePasswordRequest)
Changes the password for a specified user in a user pool.
|
default ConfirmDeviceResponse |
confirmDevice(ConfirmDeviceRequest confirmDeviceRequest)
Confirms tracking of the device.
|
default ConfirmDeviceResponse |
confirmDevice(Consumer<ConfirmDeviceRequest.Builder> confirmDeviceRequest)
Confirms tracking of the device.
|
default ConfirmForgotPasswordResponse |
confirmForgotPassword(ConfirmForgotPasswordRequest confirmForgotPasswordRequest)
Allows a user to enter a confirmation code to reset a forgotten password.
|
default ConfirmForgotPasswordResponse |
confirmForgotPassword(Consumer<ConfirmForgotPasswordRequest.Builder> confirmForgotPasswordRequest)
Allows a user to enter a confirmation code to reset a forgotten password.
|
default ConfirmSignUpResponse |
confirmSignUp(ConfirmSignUpRequest confirmSignUpRequest)
Confirms registration of a user and handles the existing alias from a previous user.
|
default ConfirmSignUpResponse |
confirmSignUp(Consumer<ConfirmSignUpRequest.Builder> confirmSignUpRequest)
Confirms registration of a user and handles the existing alias from a previous user.
|
static CognitoIdentityProviderClient |
create()
Create a
CognitoIdentityProviderClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateGroupResponse |
createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest)
Creates a new group in the specified user pool.
|
default CreateGroupResponse |
createGroup(CreateGroupRequest createGroupRequest)
Creates a new group in the specified user pool.
|
default CreateIdentityProviderResponse |
createIdentityProvider(Consumer<CreateIdentityProviderRequest.Builder> createIdentityProviderRequest)
Creates an identity provider for a user pool.
|
default CreateIdentityProviderResponse |
createIdentityProvider(CreateIdentityProviderRequest createIdentityProviderRequest)
Creates an identity provider for a user pool.
|
default CreateResourceServerResponse |
createResourceServer(Consumer<CreateResourceServerRequest.Builder> createResourceServerRequest)
Creates a new OAuth2.0 resource server and defines custom scopes in it.
|
default CreateResourceServerResponse |
createResourceServer(CreateResourceServerRequest createResourceServerRequest)
Creates a new OAuth2.0 resource server and defines custom scopes in it.
|
default CreateUserImportJobResponse |
createUserImportJob(Consumer<CreateUserImportJobRequest.Builder> createUserImportJobRequest)
Creates the user import job.
|
default CreateUserImportJobResponse |
createUserImportJob(CreateUserImportJobRequest createUserImportJobRequest)
Creates the user import job.
|
default CreateUserPoolResponse |
createUserPool(Consumer<CreateUserPoolRequest.Builder> createUserPoolRequest)
Creates a new Amazon Cognito user pool and sets the password policy for the pool.
|
default CreateUserPoolResponse |
createUserPool(CreateUserPoolRequest createUserPoolRequest)
Creates a new Amazon Cognito user pool and sets the password policy for the pool.
|
default CreateUserPoolClientResponse |
createUserPoolClient(Consumer<CreateUserPoolClientRequest.Builder> createUserPoolClientRequest)
Creates the user pool client.
|
default CreateUserPoolClientResponse |
createUserPoolClient(CreateUserPoolClientRequest createUserPoolClientRequest)
Creates the user pool client.
|
default CreateUserPoolDomainResponse |
createUserPoolDomain(Consumer<CreateUserPoolDomainRequest.Builder> createUserPoolDomainRequest)
Creates a new domain for a user pool.
|
default CreateUserPoolDomainResponse |
createUserPoolDomain(CreateUserPoolDomainRequest createUserPoolDomainRequest)
Creates a new domain for a user pool.
|
default DeleteGroupResponse |
deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)
Deletes a group.
|
default DeleteGroupResponse |
deleteGroup(DeleteGroupRequest deleteGroupRequest)
Deletes a group.
|
default DeleteIdentityProviderResponse |
deleteIdentityProvider(Consumer<DeleteIdentityProviderRequest.Builder> deleteIdentityProviderRequest)
Deletes an identity provider for a user pool.
|
default DeleteIdentityProviderResponse |
deleteIdentityProvider(DeleteIdentityProviderRequest deleteIdentityProviderRequest)
Deletes an identity provider for a user pool.
|
default DeleteResourceServerResponse |
deleteResourceServer(Consumer<DeleteResourceServerRequest.Builder> deleteResourceServerRequest)
Deletes a resource server.
|
default DeleteResourceServerResponse |
deleteResourceServer(DeleteResourceServerRequest deleteResourceServerRequest)
Deletes a resource server.
|
default DeleteUserResponse |
deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)
Allows a user to delete himself or herself.
|
default DeleteUserResponse |
deleteUser(DeleteUserRequest deleteUserRequest)
Allows a user to delete himself or herself.
|
default DeleteUserAttributesResponse |
deleteUserAttributes(Consumer<DeleteUserAttributesRequest.Builder> deleteUserAttributesRequest)
Deletes the attributes for a user.
|
default DeleteUserAttributesResponse |
deleteUserAttributes(DeleteUserAttributesRequest deleteUserAttributesRequest)
Deletes the attributes for a user.
|
default DeleteUserPoolResponse |
deleteUserPool(Consumer<DeleteUserPoolRequest.Builder> deleteUserPoolRequest)
Deletes the specified Amazon Cognito user pool.
|
default DeleteUserPoolResponse |
deleteUserPool(DeleteUserPoolRequest deleteUserPoolRequest)
Deletes the specified Amazon Cognito user pool.
|
default DeleteUserPoolClientResponse |
deleteUserPoolClient(Consumer<DeleteUserPoolClientRequest.Builder> deleteUserPoolClientRequest)
Allows the developer to delete the user pool client.
|
default DeleteUserPoolClientResponse |
deleteUserPoolClient(DeleteUserPoolClientRequest deleteUserPoolClientRequest)
Allows the developer to delete the user pool client.
|
default DeleteUserPoolDomainResponse |
deleteUserPoolDomain(Consumer<DeleteUserPoolDomainRequest.Builder> deleteUserPoolDomainRequest)
Deletes a domain for a user pool.
|
default DeleteUserPoolDomainResponse |
deleteUserPoolDomain(DeleteUserPoolDomainRequest deleteUserPoolDomainRequest)
Deletes a domain for a user pool.
|
default DescribeIdentityProviderResponse |
describeIdentityProvider(Consumer<DescribeIdentityProviderRequest.Builder> describeIdentityProviderRequest)
Gets information about a specific identity provider.
|
default DescribeIdentityProviderResponse |
describeIdentityProvider(DescribeIdentityProviderRequest describeIdentityProviderRequest)
Gets information about a specific identity provider.
|
default DescribeResourceServerResponse |
describeResourceServer(Consumer<DescribeResourceServerRequest.Builder> describeResourceServerRequest)
Describes a resource server.
|
default DescribeResourceServerResponse |
describeResourceServer(DescribeResourceServerRequest describeResourceServerRequest)
Describes a resource server.
|
default DescribeRiskConfigurationResponse |
describeRiskConfiguration(Consumer<DescribeRiskConfigurationRequest.Builder> describeRiskConfigurationRequest)
Describes the risk configuration.
|
default DescribeRiskConfigurationResponse |
describeRiskConfiguration(DescribeRiskConfigurationRequest describeRiskConfigurationRequest)
Describes the risk configuration.
|
default DescribeUserImportJobResponse |
describeUserImportJob(Consumer<DescribeUserImportJobRequest.Builder> describeUserImportJobRequest)
Describes the user import job.
|
default DescribeUserImportJobResponse |
describeUserImportJob(DescribeUserImportJobRequest describeUserImportJobRequest)
Describes the user import job.
|
default DescribeUserPoolResponse |
describeUserPool(Consumer<DescribeUserPoolRequest.Builder> describeUserPoolRequest)
Returns the configuration information and metadata of the specified user pool.
|
default DescribeUserPoolResponse |
describeUserPool(DescribeUserPoolRequest describeUserPoolRequest)
Returns the configuration information and metadata of the specified user pool.
|
default DescribeUserPoolClientResponse |
describeUserPoolClient(Consumer<DescribeUserPoolClientRequest.Builder> describeUserPoolClientRequest)
Client method for returning the configuration information and metadata of the specified user pool app client.
|
default DescribeUserPoolClientResponse |
describeUserPoolClient(DescribeUserPoolClientRequest describeUserPoolClientRequest)
Client method for returning the configuration information and metadata of the specified user pool app client.
|
default DescribeUserPoolDomainResponse |
describeUserPoolDomain(Consumer<DescribeUserPoolDomainRequest.Builder> describeUserPoolDomainRequest)
Gets information about a domain.
|
default DescribeUserPoolDomainResponse |
describeUserPoolDomain(DescribeUserPoolDomainRequest describeUserPoolDomainRequest)
Gets information about a domain.
|
default ForgetDeviceResponse |
forgetDevice(Consumer<ForgetDeviceRequest.Builder> forgetDeviceRequest)
Forgets the specified device.
|
default ForgetDeviceResponse |
forgetDevice(ForgetDeviceRequest forgetDeviceRequest)
Forgets the specified device.
|
default 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 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 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 GetCsvHeaderResponse |
getCSVHeader(GetCsvHeaderRequest getCsvHeaderRequest)
Gets the header information for the .csv file to be used as input for the user import job.
|
default GetDeviceResponse |
getDevice(Consumer<GetDeviceRequest.Builder> getDeviceRequest)
Gets the device.
|
default GetDeviceResponse |
getDevice(GetDeviceRequest getDeviceRequest)
Gets the device.
|
default GetGroupResponse |
getGroup(Consumer<GetGroupRequest.Builder> getGroupRequest)
Gets a group.
|
default GetGroupResponse |
getGroup(GetGroupRequest getGroupRequest)
Gets a group.
|
default GetIdentityProviderByIdentifierResponse |
getIdentityProviderByIdentifier(Consumer<GetIdentityProviderByIdentifierRequest.Builder> getIdentityProviderByIdentifierRequest)
Gets the specified identity provider.
|
default GetIdentityProviderByIdentifierResponse |
getIdentityProviderByIdentifier(GetIdentityProviderByIdentifierRequest getIdentityProviderByIdentifierRequest)
Gets the specified identity provider.
|
default GetSigningCertificateResponse |
getSigningCertificate(Consumer<GetSigningCertificateRequest.Builder> getSigningCertificateRequest)
This method takes a user pool ID, and returns the signing certificate.
|
default GetSigningCertificateResponse |
getSigningCertificate(GetSigningCertificateRequest getSigningCertificateRequest)
This method takes a user pool ID, and returns the signing certificate.
|
default 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 GetUiCustomizationResponse |
getUICustomization(GetUiCustomizationRequest getUiCustomizationRequest)
Gets the UI Customization information for a particular app client's app UI, if there is something set.
|
default GetUserResponse |
getUser(Consumer<GetUserRequest.Builder> getUserRequest)
Gets the user attributes and metadata for a user.
|
default GetUserResponse |
getUser(GetUserRequest getUserRequest)
Gets the user attributes and metadata for a user.
|
default GetUserAttributeVerificationCodeResponse |
getUserAttributeVerificationCode(Consumer<GetUserAttributeVerificationCodeRequest.Builder> getUserAttributeVerificationCodeRequest)
Gets the user attribute verification code for the specified attribute name.
|
default GetUserAttributeVerificationCodeResponse |
getUserAttributeVerificationCode(GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest)
Gets the user attribute verification code for the specified attribute name.
|
default GetUserPoolMfaConfigResponse |
getUserPoolMfaConfig(Consumer<GetUserPoolMfaConfigRequest.Builder> getUserPoolMfaConfigRequest)
Gets the user pool multi-factor authentication (MFA) configuration.
|
default GetUserPoolMfaConfigResponse |
getUserPoolMfaConfig(GetUserPoolMfaConfigRequest getUserPoolMfaConfigRequest)
Gets the user pool multi-factor authentication (MFA) configuration.
|
default GlobalSignOutResponse |
globalSignOut(Consumer<GlobalSignOutRequest.Builder> globalSignOutRequest)
Signs out users from all devices.
|
default GlobalSignOutResponse |
globalSignOut(GlobalSignOutRequest globalSignOutRequest)
Signs out users from all devices.
|
default InitiateAuthResponse |
initiateAuth(Consumer<InitiateAuthRequest.Builder> initiateAuthRequest)
Initiates the authentication flow.
|
default InitiateAuthResponse |
initiateAuth(InitiateAuthRequest initiateAuthRequest)
Initiates the authentication flow.
|
default ListDevicesResponse |
listDevices(Consumer<ListDevicesRequest.Builder> listDevicesRequest)
Lists the devices.
|
default ListDevicesResponse |
listDevices(ListDevicesRequest listDevicesRequest)
Lists the devices.
|
default ListGroupsResponse |
listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
Lists the groups associated with a user pool.
|
default ListGroupsResponse |
listGroups(ListGroupsRequest listGroupsRequest)
Lists the groups associated with a user pool.
|
default ListGroupsIterable |
listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
Lists the groups associated with a user pool.
|
default ListGroupsIterable |
listGroupsPaginator(ListGroupsRequest listGroupsRequest)
Lists the groups associated with a user pool.
|
default ListIdentityProvidersResponse |
listIdentityProviders(Consumer<ListIdentityProvidersRequest.Builder> listIdentityProvidersRequest)
Lists information about all identity providers for a user pool.
|
default ListIdentityProvidersResponse |
listIdentityProviders(ListIdentityProvidersRequest listIdentityProvidersRequest)
Lists information about all identity providers for a user pool.
|
default ListIdentityProvidersIterable |
listIdentityProvidersPaginator(Consumer<ListIdentityProvidersRequest.Builder> listIdentityProvidersRequest)
Lists information about all identity providers for a user pool.
|
default ListIdentityProvidersIterable |
listIdentityProvidersPaginator(ListIdentityProvidersRequest listIdentityProvidersRequest)
Lists information about all identity providers for a user pool.
|
default ListResourceServersResponse |
listResourceServers(Consumer<ListResourceServersRequest.Builder> listResourceServersRequest)
Lists the resource servers for a user pool.
|
default ListResourceServersResponse |
listResourceServers(ListResourceServersRequest listResourceServersRequest)
Lists the resource servers for a user pool.
|
default ListResourceServersIterable |
listResourceServersPaginator(Consumer<ListResourceServersRequest.Builder> listResourceServersRequest)
Lists the resource servers for a user pool.
|
default ListResourceServersIterable |
listResourceServersPaginator(ListResourceServersRequest listResourceServersRequest)
Lists the resource servers for a user pool.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags that are assigned to an Amazon Cognito user pool.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags that are assigned to an Amazon Cognito user pool.
|
default ListUserImportJobsResponse |
listUserImportJobs(Consumer<ListUserImportJobsRequest.Builder> listUserImportJobsRequest)
Lists the user import jobs.
|
default ListUserImportJobsResponse |
listUserImportJobs(ListUserImportJobsRequest listUserImportJobsRequest)
Lists the user import jobs.
|
default ListUserPoolClientsResponse |
listUserPoolClients(Consumer<ListUserPoolClientsRequest.Builder> listUserPoolClientsRequest)
Lists the clients that have been created for the specified user pool.
|
default ListUserPoolClientsResponse |
listUserPoolClients(ListUserPoolClientsRequest listUserPoolClientsRequest)
Lists the clients that have been created for the specified user pool.
|
default ListUserPoolClientsIterable |
listUserPoolClientsPaginator(Consumer<ListUserPoolClientsRequest.Builder> listUserPoolClientsRequest)
Lists the clients that have been created for the specified user pool.
|
default ListUserPoolClientsIterable |
listUserPoolClientsPaginator(ListUserPoolClientsRequest listUserPoolClientsRequest)
Lists the clients that have been created for the specified user pool.
|
default ListUserPoolsResponse |
listUserPools(Consumer<ListUserPoolsRequest.Builder> listUserPoolsRequest)
Lists the user pools associated with an AWS account.
|
default ListUserPoolsResponse |
listUserPools(ListUserPoolsRequest listUserPoolsRequest)
Lists the user pools associated with an AWS account.
|
default ListUserPoolsIterable |
listUserPoolsPaginator(Consumer<ListUserPoolsRequest.Builder> listUserPoolsRequest)
Lists the user pools associated with an AWS account.
|
default ListUserPoolsIterable |
listUserPoolsPaginator(ListUserPoolsRequest listUserPoolsRequest)
Lists the user pools associated with an AWS account.
|
default ListUsersResponse |
listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)
Lists the users in the Amazon Cognito user pool.
|
default ListUsersResponse |
listUsers(ListUsersRequest listUsersRequest)
Lists the users in the Amazon Cognito user pool.
|
default ListUsersInGroupResponse |
listUsersInGroup(Consumer<ListUsersInGroupRequest.Builder> listUsersInGroupRequest)
Lists the users in the specified group.
|
default ListUsersInGroupResponse |
listUsersInGroup(ListUsersInGroupRequest listUsersInGroupRequest)
Lists the users in the specified group.
|
default ListUsersInGroupIterable |
listUsersInGroupPaginator(Consumer<ListUsersInGroupRequest.Builder> listUsersInGroupRequest)
Lists the users in the specified group.
|
default ListUsersInGroupIterable |
listUsersInGroupPaginator(ListUsersInGroupRequest listUsersInGroupRequest)
Lists the users in the specified group.
|
default ListUsersIterable |
listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest)
Lists the users in the Amazon Cognito user pool.
|
default ListUsersIterable |
listUsersPaginator(ListUsersRequest listUsersRequest)
Lists the users in the Amazon Cognito user pool.
|
default ResendConfirmationCodeResponse |
resendConfirmationCode(Consumer<ResendConfirmationCodeRequest.Builder> resendConfirmationCodeRequest)
Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
|
default ResendConfirmationCodeResponse |
resendConfirmationCode(ResendConfirmationCodeRequest resendConfirmationCodeRequest)
Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
|
default RespondToAuthChallengeResponse |
respondToAuthChallenge(Consumer<RespondToAuthChallengeRequest.Builder> respondToAuthChallengeRequest)
Responds to the authentication challenge.
|
default RespondToAuthChallengeResponse |
respondToAuthChallenge(RespondToAuthChallengeRequest respondToAuthChallengeRequest)
Responds to the authentication challenge.
|
static ServiceMetadata |
serviceMetadata() |
default SetRiskConfigurationResponse |
setRiskConfiguration(Consumer<SetRiskConfigurationRequest.Builder> setRiskConfigurationRequest)
Configures actions on detected risks.
|
default SetRiskConfigurationResponse |
setRiskConfiguration(SetRiskConfigurationRequest setRiskConfigurationRequest)
Configures actions on detected risks.
|
default SetUiCustomizationResponse |
setUICustomization(Consumer<SetUiCustomizationRequest.Builder> setUiCustomizationRequest)
Sets the UI customization information for a user pool's built-in app UI.
|
default SetUiCustomizationResponse |
setUICustomization(SetUiCustomizationRequest setUiCustomizationRequest)
Sets the UI customization information for a user pool's built-in app UI.
|
default 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 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 SetUserPoolMfaConfigResponse |
setUserPoolMfaConfig(Consumer<SetUserPoolMfaConfigRequest.Builder> setUserPoolMfaConfigRequest)
Set the user pool multi-factor authentication (MFA) configuration.
|
default SetUserPoolMfaConfigResponse |
setUserPoolMfaConfig(SetUserPoolMfaConfigRequest setUserPoolMfaConfigRequest)
Set the user pool multi-factor authentication (MFA) configuration.
|
default SetUserSettingsResponse |
setUserSettings(Consumer<SetUserSettingsRequest.Builder> setUserSettingsRequest)
This action is no longer supported. You can use it to configure only SMS MFA.
|
default SetUserSettingsResponse |
setUserSettings(SetUserSettingsRequest setUserSettingsRequest)
This action is no longer supported. You can use it to configure only SMS MFA.
|
default SignUpResponse |
signUp(Consumer<SignUpRequest.Builder> signUpRequest)
Registers the user in the specified user pool and creates a user name, password, and user attributes.
|
default SignUpResponse |
signUp(SignUpRequest signUpRequest)
Registers the user in the specified user pool and creates a user name, password, and user attributes.
|
default StartUserImportJobResponse |
startUserImportJob(Consumer<StartUserImportJobRequest.Builder> startUserImportJobRequest)
Starts the user import.
|
default StartUserImportJobResponse |
startUserImportJob(StartUserImportJobRequest startUserImportJobRequest)
Starts the user import.
|
default StopUserImportJobResponse |
stopUserImportJob(Consumer<StopUserImportJobRequest.Builder> stopUserImportJobRequest)
Stops the user import job.
|
default StopUserImportJobResponse |
stopUserImportJob(StopUserImportJobRequest stopUserImportJobRequest)
Stops the user import job.
|
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Assigns a set of tags to an Amazon Cognito user pool.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Assigns a set of tags to an Amazon Cognito user pool.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes the specified tags from an Amazon Cognito user pool.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Removes the specified tags from an Amazon Cognito user pool.
|
default UpdateAuthEventFeedbackResponse |
updateAuthEventFeedback(Consumer<UpdateAuthEventFeedbackRequest.Builder> updateAuthEventFeedbackRequest)
Provides the feedback for an authentication event whether it was from a valid user or not.
|
default UpdateAuthEventFeedbackResponse |
updateAuthEventFeedback(UpdateAuthEventFeedbackRequest updateAuthEventFeedbackRequest)
Provides the feedback for an authentication event whether it was from a valid user or not.
|
default UpdateDeviceStatusResponse |
updateDeviceStatus(Consumer<UpdateDeviceStatusRequest.Builder> updateDeviceStatusRequest)
Updates the device status.
|
default UpdateDeviceStatusResponse |
updateDeviceStatus(UpdateDeviceStatusRequest updateDeviceStatusRequest)
Updates the device status.
|
default UpdateGroupResponse |
updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest)
Updates the specified group with the specified attributes.
|
default UpdateGroupResponse |
updateGroup(UpdateGroupRequest updateGroupRequest)
Updates the specified group with the specified attributes.
|
default UpdateIdentityProviderResponse |
updateIdentityProvider(Consumer<UpdateIdentityProviderRequest.Builder> updateIdentityProviderRequest)
Updates identity provider information for a user pool.
|
default UpdateIdentityProviderResponse |
updateIdentityProvider(UpdateIdentityProviderRequest updateIdentityProviderRequest)
Updates identity provider information for a user pool.
|
default UpdateResourceServerResponse |
updateResourceServer(Consumer<UpdateResourceServerRequest.Builder> updateResourceServerRequest)
Updates the name and scopes of resource server.
|
default UpdateResourceServerResponse |
updateResourceServer(UpdateResourceServerRequest updateResourceServerRequest)
Updates the name and scopes of resource server.
|
default UpdateUserAttributesResponse |
updateUserAttributes(Consumer<UpdateUserAttributesRequest.Builder> updateUserAttributesRequest)
Allows a user to update a specific attribute (one at a time).
|
default UpdateUserAttributesResponse |
updateUserAttributes(UpdateUserAttributesRequest updateUserAttributesRequest)
Allows a user to update a specific attribute (one at a time).
|
default UpdateUserPoolResponse |
updateUserPool(Consumer<UpdateUserPoolRequest.Builder> updateUserPoolRequest)
Updates the specified user pool with the specified attributes.
|
default UpdateUserPoolResponse |
updateUserPool(UpdateUserPoolRequest updateUserPoolRequest)
Updates the specified user pool with the specified attributes.
|
default UpdateUserPoolClientResponse |
updateUserPoolClient(Consumer<UpdateUserPoolClientRequest.Builder> updateUserPoolClientRequest)
Updates the specified user pool app client with the specified attributes.
|
default UpdateUserPoolClientResponse |
updateUserPoolClient(UpdateUserPoolClientRequest updateUserPoolClientRequest)
Updates the specified user pool app client with the specified attributes.
|
default UpdateUserPoolDomainResponse |
updateUserPoolDomain(Consumer<UpdateUserPoolDomainRequest.Builder> updateUserPoolDomainRequest)
Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.
|
default UpdateUserPoolDomainResponse |
updateUserPoolDomain(UpdateUserPoolDomainRequest updateUserPoolDomainRequest)
Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.
|
default 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 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 VerifyUserAttributeResponse |
verifyUserAttribute(Consumer<VerifyUserAttributeRequest.Builder> verifyUserAttributeRequest)
Verifies the specified user attributes in the user pool.
|
default VerifyUserAttributeResponse |
verifyUserAttribute(VerifyUserAttributeRequest verifyUserAttributeRequest)
Verifies the specified user attributes in the user pool.
|
serviceName
close
static final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider
.static CognitoIdentityProviderClient create()
CognitoIdentityProviderClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static CognitoIdentityProviderClientBuilder builder()
CognitoIdentityProviderClient
.default AddCustomAttributesResponse addCustomAttributes(AddCustomAttributesRequest addCustomAttributesRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserImportInProgressException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Adds additional user attributes to the user pool schema.
addCustomAttributesRequest
- Represents the request to add custom attributes.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserImportInProgressException
- This exception is thrown when you are trying to modify a user pool while a user import job is in progress
for that pool.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AddCustomAttributesResponse addCustomAttributes(Consumer<AddCustomAttributesRequest.Builder> addCustomAttributesRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserImportInProgressException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserImportInProgressException
- This exception is thrown when you are trying to modify a user pool while a user import job is in progress
for that pool.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminAddUserToGroupResponse adminAddUserToGroup(AdminAddUserToGroupRequest adminAddUserToGroupRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Adds the specified user to the specified group.
Calling this action requires developer credentials.
adminAddUserToGroupRequest
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminAddUserToGroupResponse adminAddUserToGroup(Consumer<AdminAddUserToGroupRequest.Builder> adminAddUserToGroupRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminConfirmSignUpResponse adminConfirmSignUp(AdminConfirmSignUpRequest adminConfirmSignUpRequest) throws ResourceNotFoundException, InvalidParameterException, UnexpectedLambdaException, UserLambdaValidationException, NotAuthorizedException, TooManyFailedAttemptsException, InvalidLambdaResponseException, TooManyRequestsException, LimitExceededException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyFailedAttemptsException
- This exception is thrown when the user has made too many failed attempts for a given action (e.g., sign
in).InvalidLambdaResponseException
- This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminConfirmSignUpResponse adminConfirmSignUp(Consumer<AdminConfirmSignUpRequest.Builder> adminConfirmSignUpRequest) throws ResourceNotFoundException, InvalidParameterException, UnexpectedLambdaException, UserLambdaValidationException, NotAuthorizedException, TooManyFailedAttemptsException, InvalidLambdaResponseException, TooManyRequestsException, LimitExceededException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyFailedAttemptsException
- This exception is thrown when the user has made too many failed attempts for a given action (e.g., sign
in).InvalidLambdaResponseException
- This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminCreateUserResponse adminCreateUser(AdminCreateUserRequest adminCreateUserRequest) throws ResourceNotFoundException, InvalidParameterException, UserNotFoundException, UsernameExistsException, InvalidPasswordException, CodeDeliveryFailureException, UnexpectedLambdaException, UserLambdaValidationException, InvalidLambdaResponseException, PreconditionNotMetException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, TooManyRequestsException, NotAuthorizedException, UnsupportedUserStateException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UserNotFoundException
- This exception is thrown when a user is not found.UsernameExistsException
- This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.InvalidPasswordException
- This exception is thrown when the Amazon Cognito service encounters an invalid password.CodeDeliveryFailureException
- This exception is thrown when a verification code fails to deliver successfully.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.InvalidLambdaResponseException
- This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.PreconditionNotMetException
- This exception is thrown when a precondition is not met.InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException
- This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UnsupportedUserStateException
- The request failed because the user is in an unsupported state.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminCreateUserResponse adminCreateUser(Consumer<AdminCreateUserRequest.Builder> adminCreateUserRequest) throws ResourceNotFoundException, InvalidParameterException, UserNotFoundException, UsernameExistsException, InvalidPasswordException, CodeDeliveryFailureException, UnexpectedLambdaException, UserLambdaValidationException, InvalidLambdaResponseException, PreconditionNotMetException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, TooManyRequestsException, NotAuthorizedException, UnsupportedUserStateException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UserNotFoundException
- This exception is thrown when a user is not found.UsernameExistsException
- This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.InvalidPasswordException
- This exception is thrown when the Amazon Cognito service encounters an invalid password.CodeDeliveryFailureException
- This exception is thrown when a verification code fails to deliver successfully.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.InvalidLambdaResponseException
- This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.PreconditionNotMetException
- This exception is thrown when a precondition is not met.InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException
- This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UnsupportedUserStateException
- The request failed because the user is in an unsupported state.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminDeleteUserResponse adminDeleteUser(AdminDeleteUserRequest adminDeleteUserRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminDeleteUserResponse adminDeleteUser(Consumer<AdminDeleteUserRequest.Builder> adminDeleteUserRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminDeleteUserAttributesResponse adminDeleteUserAttributes(AdminDeleteUserAttributesRequest adminDeleteUserAttributesRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminDeleteUserAttributesResponse adminDeleteUserAttributes(Consumer<AdminDeleteUserAttributesRequest.Builder> adminDeleteUserAttributesRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminDisableProviderForUserResponse adminDisableProviderForUser(AdminDisableProviderForUserRequest adminDisableProviderForUserRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, AliasExistsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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
- ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.AliasExistsException
- This exception is thrown when a user tries to confirm the account with an email or phone number that has
already been supplied as an alias from a different account. This exception tells user that an account
with this email or phone already exists.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminDisableProviderForUserResponse adminDisableProviderForUser(Consumer<AdminDisableProviderForUserRequest.Builder> adminDisableProviderForUserRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, AliasExistsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.AliasExistsException
- This exception is thrown when a user tries to confirm the account with an email or phone number that has
already been supplied as an alias from a different account. This exception tells user that an account
with this email or phone already exists.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminDisableUserResponse adminDisableUser(AdminDisableUserRequest adminDisableUserRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Disables the specified user.
Calling this action requires developer credentials.
adminDisableUserRequest
- Represents the request to disable any user as an administrator.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminDisableUserResponse adminDisableUser(Consumer<AdminDisableUserRequest.Builder> adminDisableUserRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminEnableUserResponse adminEnableUser(AdminEnableUserRequest adminEnableUserRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminEnableUserResponse adminEnableUser(Consumer<AdminEnableUserRequest.Builder> adminEnableUserRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminForgetDeviceResponse adminForgetDevice(AdminForgetDeviceRequest adminForgetDeviceRequest) throws ResourceNotFoundException, InvalidParameterException, InvalidUserPoolConfigurationException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Forgets the device, as an administrator.
Calling this action requires developer credentials.
adminForgetDeviceRequest
- Sends the forgot device request, as an administrator.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminForgetDeviceResponse adminForgetDevice(Consumer<AdminForgetDeviceRequest.Builder> adminForgetDeviceRequest) throws ResourceNotFoundException, InvalidParameterException, InvalidUserPoolConfigurationException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminGetDeviceResponse adminGetDevice(AdminGetDeviceRequest adminGetDeviceRequest) throws ResourceNotFoundException, InvalidParameterException, InvalidUserPoolConfigurationException, TooManyRequestsException, InternalErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Gets the device, as an administrator.
Calling this action requires developer credentials.
adminGetDeviceRequest
- Represents the request to get the device, as an administrator.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.NotAuthorizedException
- This exception is thrown when a user is not authorized.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminGetDeviceResponse adminGetDevice(Consumer<AdminGetDeviceRequest.Builder> adminGetDeviceRequest) throws ResourceNotFoundException, InvalidParameterException, InvalidUserPoolConfigurationException, TooManyRequestsException, InternalErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.NotAuthorizedException
- This exception is thrown when a user is not authorized.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminGetUserResponse adminGetUser(AdminGetUserRequest adminGetUserRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminGetUserResponse adminGetUser(Consumer<AdminGetUserRequest.Builder> adminGetUserRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminInitiateAuthResponse adminInitiateAuth(AdminInitiateAuthRequest adminInitiateAuthRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, UnexpectedLambdaException, InvalidUserPoolConfigurationException, UserLambdaValidationException, InvalidLambdaResponseException, MfaMethodNotFoundException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Initiates the authentication flow, as an administrator.
Calling this action requires developer credentials.
adminInitiateAuthRequest
- Initiates the authorization request, as an administrator.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.InvalidLambdaResponseException
- This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.MfaMethodNotFoundException
- This exception is thrown when Amazon Cognito cannot find a multi-factor authentication (MFA) method.InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException
- This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminInitiateAuthResponse adminInitiateAuth(Consumer<AdminInitiateAuthRequest.Builder> adminInitiateAuthRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, UnexpectedLambdaException, InvalidUserPoolConfigurationException, UserLambdaValidationException, InvalidLambdaResponseException, MfaMethodNotFoundException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.InvalidLambdaResponseException
- This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.MfaMethodNotFoundException
- This exception is thrown when Amazon Cognito cannot find a multi-factor authentication (MFA) method.InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException
- This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminLinkProviderForUserResponse adminLinkProviderForUser(AdminLinkProviderForUserRequest adminLinkProviderForUserRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, AliasExistsException, LimitExceededException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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
- ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.AliasExistsException
- This exception is thrown when a user tries to confirm the account with an email or phone number that has
already been supplied as an alias from a different account. This exception tells user that an account
with this email or phone already exists.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminLinkProviderForUserResponse adminLinkProviderForUser(Consumer<AdminLinkProviderForUserRequest.Builder> adminLinkProviderForUserRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, AliasExistsException, LimitExceededException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.AliasExistsException
- This exception is thrown when a user tries to confirm the account with an email or phone number that has
already been supplied as an alias from a different account. This exception tells user that an account
with this email or phone already exists.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminListDevicesResponse adminListDevices(AdminListDevicesRequest adminListDevicesRequest) throws InvalidParameterException, ResourceNotFoundException, InvalidUserPoolConfigurationException, TooManyRequestsException, InternalErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists devices, as an administrator.
Calling this action requires developer credentials.
adminListDevicesRequest
- Represents the request to list devices, as an administrator.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.NotAuthorizedException
- This exception is thrown when a user is not authorized.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminListDevicesResponse adminListDevices(Consumer<AdminListDevicesRequest.Builder> adminListDevicesRequest) throws InvalidParameterException, ResourceNotFoundException, InvalidUserPoolConfigurationException, TooManyRequestsException, InternalErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.NotAuthorizedException
- This exception is thrown when a user is not authorized.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminListGroupsForUserResponse adminListGroupsForUser(AdminListGroupsForUserRequest adminListGroupsForUserRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the groups that the user belongs to.
Calling this action requires developer credentials.
adminListGroupsForUserRequest
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminListGroupsForUserResponse adminListGroupsForUser(Consumer<AdminListGroupsForUserRequest.Builder> adminListGroupsForUserRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminListGroupsForUserIterable adminListGroupsForUserPaginator(AdminListGroupsForUserRequest adminListGroupsForUserRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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 iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cognitoidentityprovider.paginators.AdminListGroupsForUserIterable responses = client.adminListGroupsForUserPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.cognitoidentityprovider.paginators.AdminListGroupsForUserIterable responses = client .adminListGroupsForUserPaginator(request); for (software.amazon.awssdk.services.cognitoidentityprovider.model.AdminListGroupsForUserResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.cognitoidentityprovider.paginators.AdminListGroupsForUserIterable responses = client.adminListGroupsForUserPaginator(request);
responses.iterator().forEachRemaining(....);
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
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminListGroupsForUserIterable adminListGroupsForUserPaginator(Consumer<AdminListGroupsForUserRequest.Builder> adminListGroupsForUserRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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 iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cognitoidentityprovider.paginators.AdminListGroupsForUserIterable responses = client.adminListGroupsForUserPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.cognitoidentityprovider.paginators.AdminListGroupsForUserIterable responses = client .adminListGroupsForUserPaginator(request); for (software.amazon.awssdk.services.cognitoidentityprovider.model.AdminListGroupsForUserResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.cognitoidentityprovider.paginators.AdminListGroupsForUserIterable responses = client.adminListGroupsForUserPaginator(request);
responses.iterator().forEachRemaining(....);
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.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminListUserAuthEventsResponse adminListUserAuthEvents(AdminListUserAuthEventsRequest adminListUserAuthEventsRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, UserPoolAddOnNotEnabledException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security.
adminListUserAuthEventsRequest
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.UserPoolAddOnNotEnabledException
- This exception is thrown when user pool add-ons are not enabled.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminListUserAuthEventsResponse adminListUserAuthEvents(Consumer<AdminListUserAuthEventsRequest.Builder> adminListUserAuthEventsRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, UserPoolAddOnNotEnabledException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.UserPoolAddOnNotEnabledException
- This exception is thrown when user pool add-ons are not enabled.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminListUserAuthEventsIterable adminListUserAuthEventsPaginator(AdminListUserAuthEventsRequest adminListUserAuthEventsRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, UserPoolAddOnNotEnabledException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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 iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cognitoidentityprovider.paginators.AdminListUserAuthEventsIterable responses = client.adminListUserAuthEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.cognitoidentityprovider.paginators.AdminListUserAuthEventsIterable responses = client .adminListUserAuthEventsPaginator(request); for (software.amazon.awssdk.services.cognitoidentityprovider.model.AdminListUserAuthEventsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.cognitoidentityprovider.paginators.AdminListUserAuthEventsIterable responses = client.adminListUserAuthEventsPaginator(request);
responses.iterator().forEachRemaining(....);
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
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.UserPoolAddOnNotEnabledException
- This exception is thrown when user pool add-ons are not enabled.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminListUserAuthEventsIterable adminListUserAuthEventsPaginator(Consumer<AdminListUserAuthEventsRequest.Builder> adminListUserAuthEventsRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, UserPoolAddOnNotEnabledException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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 iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cognitoidentityprovider.paginators.AdminListUserAuthEventsIterable responses = client.adminListUserAuthEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.cognitoidentityprovider.paginators.AdminListUserAuthEventsIterable responses = client .adminListUserAuthEventsPaginator(request); for (software.amazon.awssdk.services.cognitoidentityprovider.model.AdminListUserAuthEventsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.cognitoidentityprovider.paginators.AdminListUserAuthEventsIterable responses = client.adminListUserAuthEventsPaginator(request);
responses.iterator().forEachRemaining(....);
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.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.UserPoolAddOnNotEnabledException
- This exception is thrown when user pool add-ons are not enabled.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminRemoveUserFromGroupResponse adminRemoveUserFromGroup(AdminRemoveUserFromGroupRequest adminRemoveUserFromGroupRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Removes the specified user from the specified group.
Calling this action requires developer credentials.
adminRemoveUserFromGroupRequest
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminRemoveUserFromGroupResponse adminRemoveUserFromGroup(Consumer<AdminRemoveUserFromGroupRequest.Builder> adminRemoveUserFromGroupRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminResetUserPasswordResponse adminResetUserPassword(AdminResetUserPasswordRequest adminResetUserPasswordRequest) throws ResourceNotFoundException, InvalidParameterException, UnexpectedLambdaException, UserLambdaValidationException, NotAuthorizedException, InvalidLambdaResponseException, TooManyRequestsException, LimitExceededException, UserNotFoundException, InvalidSmsRoleAccessPolicyException, InvalidEmailRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.NotAuthorizedException
- This exception is thrown when a user is not authorized.InvalidLambdaResponseException
- This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.UserNotFoundException
- This exception is thrown when a user is not found.InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidEmailRoleAccessPolicyException
- This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code:
400.InvalidSmsRoleTrustRelationshipException
- This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminResetUserPasswordResponse adminResetUserPassword(Consumer<AdminResetUserPasswordRequest.Builder> adminResetUserPasswordRequest) throws ResourceNotFoundException, InvalidParameterException, UnexpectedLambdaException, UserLambdaValidationException, NotAuthorizedException, InvalidLambdaResponseException, TooManyRequestsException, LimitExceededException, UserNotFoundException, InvalidSmsRoleAccessPolicyException, InvalidEmailRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.NotAuthorizedException
- This exception is thrown when a user is not authorized.InvalidLambdaResponseException
- This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.UserNotFoundException
- This exception is thrown when a user is not found.InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidEmailRoleAccessPolicyException
- This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code:
400.InvalidSmsRoleTrustRelationshipException
- This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminRespondToAuthChallengeResponse adminRespondToAuthChallenge(AdminRespondToAuthChallengeRequest adminRespondToAuthChallengeRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, CodeMismatchException, ExpiredCodeException, UnexpectedLambdaException, InvalidPasswordException, UserLambdaValidationException, InvalidLambdaResponseException, TooManyRequestsException, InvalidUserPoolConfigurationException, InternalErrorException, MfaMethodNotFoundException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, AliasExistsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, SoftwareTokenMfaNotFoundException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException
- This exception is thrown when a user is not authorized.CodeMismatchException
- This exception is thrown if the provided code does not match what the server was expecting.ExpiredCodeException
- This exception is thrown if a code has expired.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.InvalidPasswordException
- This exception is thrown when the Amazon Cognito service encounters an invalid password.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.InvalidLambdaResponseException
- This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.MfaMethodNotFoundException
- This exception is thrown when Amazon Cognito cannot find a multi-factor authentication (MFA) method.InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException
- This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.AliasExistsException
- This exception is thrown when a user tries to confirm the account with an email or phone number that has
already been supplied as an alias from a different account. This exception tells user that an account
with this email or phone already exists.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.SoftwareTokenMfaNotFoundException
- This exception is thrown when the software token TOTP multi-factor authentication (MFA) is not enabled
for the user pool.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminRespondToAuthChallengeResponse adminRespondToAuthChallenge(Consumer<AdminRespondToAuthChallengeRequest.Builder> adminRespondToAuthChallengeRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, CodeMismatchException, ExpiredCodeException, UnexpectedLambdaException, InvalidPasswordException, UserLambdaValidationException, InvalidLambdaResponseException, TooManyRequestsException, InvalidUserPoolConfigurationException, InternalErrorException, MfaMethodNotFoundException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, AliasExistsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, SoftwareTokenMfaNotFoundException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException
- This exception is thrown when a user is not authorized.CodeMismatchException
- This exception is thrown if the provided code does not match what the server was expecting.ExpiredCodeException
- This exception is thrown if a code has expired.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.InvalidPasswordException
- This exception is thrown when the Amazon Cognito service encounters an invalid password.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.InvalidLambdaResponseException
- This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.MfaMethodNotFoundException
- This exception is thrown when Amazon Cognito cannot find a multi-factor authentication (MFA) method.InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException
- This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.AliasExistsException
- This exception is thrown when a user tries to confirm the account with an email or phone number that has
already been supplied as an alias from a different account. This exception tells user that an account
with this email or phone already exists.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.SoftwareTokenMfaNotFoundException
- This exception is thrown when the software token TOTP multi-factor authentication (MFA) is not enabled
for the user pool.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminSetUserMfaPreferenceResponse adminSetUserMFAPreference(AdminSetUserMfaPreferenceRequest adminSetUserMfaPreferenceRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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
- ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException
- This exception is thrown when a user is not authorized.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminSetUserMfaPreferenceResponse adminSetUserMFAPreference(Consumer<AdminSetUserMfaPreferenceRequest.Builder> adminSetUserMfaPreferenceRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException
- This exception is thrown when a user is not authorized.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminSetUserPasswordResponse adminSetUserPassword(AdminSetUserPasswordRequest adminSetUserPasswordRequest) throws ResourceNotFoundException, NotAuthorizedException, UserNotFoundException, InternalErrorException, TooManyRequestsException, InvalidParameterException, InvalidPasswordException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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
- ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.InvalidPasswordException
- This exception is thrown when the Amazon Cognito service encounters an invalid password.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminSetUserPasswordResponse adminSetUserPassword(Consumer<AdminSetUserPasswordRequest.Builder> adminSetUserPasswordRequest) throws ResourceNotFoundException, NotAuthorizedException, UserNotFoundException, InternalErrorException, TooManyRequestsException, InvalidParameterException, InvalidPasswordException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.InvalidPasswordException
- This exception is thrown when the Amazon Cognito service encounters an invalid password.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminSetUserSettingsResponse adminSetUserSettings(AdminSetUserSettingsRequest adminSetUserSettingsRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminSetUserSettingsResponse adminSetUserSettings(Consumer<AdminSetUserSettingsRequest.Builder> adminSetUserSettingsRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminUpdateAuthEventFeedbackResponse adminUpdateAuthEventFeedback(AdminUpdateAuthEventFeedbackRequest adminUpdateAuthEventFeedbackRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, UserPoolAddOnNotEnabledException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.UserPoolAddOnNotEnabledException
- This exception is thrown when user pool add-ons are not enabled.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminUpdateAuthEventFeedbackResponse adminUpdateAuthEventFeedback(Consumer<AdminUpdateAuthEventFeedbackRequest.Builder> adminUpdateAuthEventFeedbackRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, UserPoolAddOnNotEnabledException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.UserPoolAddOnNotEnabledException
- This exception is thrown when user pool add-ons are not enabled.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminUpdateDeviceStatusResponse adminUpdateDeviceStatus(AdminUpdateDeviceStatusRequest adminUpdateDeviceStatusRequest) throws InvalidParameterException, ResourceNotFoundException, InvalidUserPoolConfigurationException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Updates the device status as an administrator.
Calling this action requires developer credentials.
adminUpdateDeviceStatusRequest
- The request to update the device status, as an administrator.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminUpdateDeviceStatusResponse adminUpdateDeviceStatus(Consumer<AdminUpdateDeviceStatusRequest.Builder> adminUpdateDeviceStatusRequest) throws InvalidParameterException, ResourceNotFoundException, InvalidUserPoolConfigurationException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminUpdateUserAttributesResponse adminUpdateUserAttributes(AdminUpdateUserAttributesRequest adminUpdateUserAttributesRequest) throws ResourceNotFoundException, InvalidParameterException, UnexpectedLambdaException, UserLambdaValidationException, InvalidLambdaResponseException, AliasExistsException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, InvalidSmsRoleAccessPolicyException, InvalidEmailRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.InvalidLambdaResponseException
- This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.AliasExistsException
- This exception is thrown when a user tries to confirm the account with an email or phone number that has
already been supplied as an alias from a different account. This exception tells user that an account
with this email or phone already exists.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidEmailRoleAccessPolicyException
- This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code:
400.InvalidSmsRoleTrustRelationshipException
- This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminUpdateUserAttributesResponse adminUpdateUserAttributes(Consumer<AdminUpdateUserAttributesRequest.Builder> adminUpdateUserAttributesRequest) throws ResourceNotFoundException, InvalidParameterException, UnexpectedLambdaException, UserLambdaValidationException, InvalidLambdaResponseException, AliasExistsException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, InvalidSmsRoleAccessPolicyException, InvalidEmailRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.InvalidLambdaResponseException
- This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.AliasExistsException
- This exception is thrown when a user tries to confirm the account with an email or phone number that has
already been supplied as an alias from a different account. This exception tells user that an account
with this email or phone already exists.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidEmailRoleAccessPolicyException
- This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code:
400.InvalidSmsRoleTrustRelationshipException
- This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminUserGlobalSignOutResponse adminUserGlobalSignOut(AdminUserGlobalSignOutRequest adminUserGlobalSignOutRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AdminUserGlobalSignOutResponse adminUserGlobalSignOut(Consumer<AdminUserGlobalSignOutRequest.Builder> adminUserGlobalSignOutRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AssociateSoftwareTokenResponse associateSoftwareToken(AssociateSoftwareTokenRequest associateSoftwareTokenRequest) throws ConcurrentModificationException, InvalidParameterException, NotAuthorizedException, ResourceNotFoundException, InternalErrorException, SoftwareTokenMfaNotFoundException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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
- ConcurrentModificationException
- This exception is thrown if two or more modifications are happening concurrently.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException
- This exception is thrown when a user is not authorized.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SoftwareTokenMfaNotFoundException
- This exception is thrown when the software token TOTP multi-factor authentication (MFA) is not enabled
for the user pool.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AssociateSoftwareTokenResponse associateSoftwareToken(Consumer<AssociateSoftwareTokenRequest.Builder> associateSoftwareTokenRequest) throws ConcurrentModificationException, InvalidParameterException, NotAuthorizedException, ResourceNotFoundException, InternalErrorException, SoftwareTokenMfaNotFoundException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ConcurrentModificationException
- This exception is thrown if two or more modifications are happening concurrently.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException
- This exception is thrown when a user is not authorized.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SoftwareTokenMfaNotFoundException
- This exception is thrown when the software token TOTP multi-factor authentication (MFA) is not enabled
for the user pool.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ChangePasswordResponse changePassword(ChangePasswordRequest changePasswordRequest) throws ResourceNotFoundException, InvalidParameterException, InvalidPasswordException, NotAuthorizedException, TooManyRequestsException, LimitExceededException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Changes the password for a specified user in a user pool.
changePasswordRequest
- Represents the request to change a user password.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.InvalidPasswordException
- This exception is thrown when the Amazon Cognito service encounters an invalid password.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ChangePasswordResponse changePassword(Consumer<ChangePasswordRequest.Builder> changePasswordRequest) throws ResourceNotFoundException, InvalidParameterException, InvalidPasswordException, NotAuthorizedException, TooManyRequestsException, LimitExceededException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.InvalidPasswordException
- This exception is thrown when the Amazon Cognito service encounters an invalid password.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ConfirmDeviceResponse confirmDevice(ConfirmDeviceRequest confirmDeviceRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, InvalidPasswordException, InvalidLambdaResponseException, UsernameExistsException, InvalidUserPoolConfigurationException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Confirms tracking of the device. This API call is the call that begins device tracking.
confirmDeviceRequest
- Confirms the device request.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException
- This exception is thrown when a user is not authorized.InvalidPasswordException
- This exception is thrown when the Amazon Cognito service encounters an invalid password.InvalidLambdaResponseException
- This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.UsernameExistsException
- This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ConfirmDeviceResponse confirmDevice(Consumer<ConfirmDeviceRequest.Builder> confirmDeviceRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, InvalidPasswordException, InvalidLambdaResponseException, UsernameExistsException, InvalidUserPoolConfigurationException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException
- This exception is thrown when a user is not authorized.InvalidPasswordException
- This exception is thrown when the Amazon Cognito service encounters an invalid password.InvalidLambdaResponseException
- This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.UsernameExistsException
- This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ConfirmForgotPasswordResponse confirmForgotPassword(ConfirmForgotPasswordRequest confirmForgotPasswordRequest) throws ResourceNotFoundException, UnexpectedLambdaException, UserLambdaValidationException, InvalidParameterException, InvalidPasswordException, NotAuthorizedException, CodeMismatchException, ExpiredCodeException, TooManyFailedAttemptsException, InvalidLambdaResponseException, TooManyRequestsException, LimitExceededException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Allows a user to enter a confirmation code to reset a forgotten password.
confirmForgotPasswordRequest
- The request representing the confirmation for a password reset.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.InvalidPasswordException
- This exception is thrown when the Amazon Cognito service encounters an invalid password.NotAuthorizedException
- This exception is thrown when a user is not authorized.CodeMismatchException
- This exception is thrown if the provided code does not match what the server was expecting.ExpiredCodeException
- This exception is thrown if a code has expired.TooManyFailedAttemptsException
- This exception is thrown when the user has made too many failed attempts for a given action (e.g., sign
in).InvalidLambdaResponseException
- This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ConfirmForgotPasswordResponse confirmForgotPassword(Consumer<ConfirmForgotPasswordRequest.Builder> confirmForgotPasswordRequest) throws ResourceNotFoundException, UnexpectedLambdaException, UserLambdaValidationException, InvalidParameterException, InvalidPasswordException, NotAuthorizedException, CodeMismatchException, ExpiredCodeException, TooManyFailedAttemptsException, InvalidLambdaResponseException, TooManyRequestsException, LimitExceededException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.InvalidPasswordException
- This exception is thrown when the Amazon Cognito service encounters an invalid password.NotAuthorizedException
- This exception is thrown when a user is not authorized.CodeMismatchException
- This exception is thrown if the provided code does not match what the server was expecting.ExpiredCodeException
- This exception is thrown if a code has expired.TooManyFailedAttemptsException
- This exception is thrown when the user has made too many failed attempts for a given action (e.g., sign
in).InvalidLambdaResponseException
- This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ConfirmSignUpResponse confirmSignUp(ConfirmSignUpRequest confirmSignUpRequest) throws ResourceNotFoundException, InvalidParameterException, UnexpectedLambdaException, UserLambdaValidationException, NotAuthorizedException, TooManyFailedAttemptsException, CodeMismatchException, ExpiredCodeException, InvalidLambdaResponseException, AliasExistsException, TooManyRequestsException, LimitExceededException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Confirms registration of a user and handles the existing alias from a previous user.
confirmSignUpRequest
- Represents the request to confirm registration of a user.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyFailedAttemptsException
- This exception is thrown when the user has made too many failed attempts for a given action (e.g., sign
in).CodeMismatchException
- This exception is thrown if the provided code does not match what the server was expecting.ExpiredCodeException
- This exception is thrown if a code has expired.InvalidLambdaResponseException
- This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.AliasExistsException
- This exception is thrown when a user tries to confirm the account with an email or phone number that has
already been supplied as an alias from a different account. This exception tells user that an account
with this email or phone already exists.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ConfirmSignUpResponse confirmSignUp(Consumer<ConfirmSignUpRequest.Builder> confirmSignUpRequest) throws ResourceNotFoundException, InvalidParameterException, UnexpectedLambdaException, UserLambdaValidationException, NotAuthorizedException, TooManyFailedAttemptsException, CodeMismatchException, ExpiredCodeException, InvalidLambdaResponseException, AliasExistsException, TooManyRequestsException, LimitExceededException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyFailedAttemptsException
- This exception is thrown when the user has made too many failed attempts for a given action (e.g., sign
in).CodeMismatchException
- This exception is thrown if the provided code does not match what the server was expecting.ExpiredCodeException
- This exception is thrown if a code has expired.InvalidLambdaResponseException
- This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.AliasExistsException
- This exception is thrown when a user tries to confirm the account with an email or phone number that has
already been supplied as an alias from a different account. This exception tells user that an account
with this email or phone already exists.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateGroupResponse createGroup(CreateGroupRequest createGroupRequest) throws InvalidParameterException, GroupExistsException, ResourceNotFoundException, TooManyRequestsException, LimitExceededException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Creates a new group in the specified user pool.
Calling this action requires developer credentials.
createGroupRequest
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.GroupExistsException
- This exception is thrown when Amazon Cognito encounters a group that already exists in the user pool.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.NotAuthorizedException
- This exception is thrown when a user is not authorized.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateGroupResponse createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest) throws InvalidParameterException, GroupExistsException, ResourceNotFoundException, TooManyRequestsException, LimitExceededException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.GroupExistsException
- This exception is thrown when Amazon Cognito encounters a group that already exists in the user pool.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.NotAuthorizedException
- This exception is thrown when a user is not authorized.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateIdentityProviderResponse createIdentityProvider(CreateIdentityProviderRequest createIdentityProviderRequest) throws InvalidParameterException, DuplicateProviderException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, LimitExceededException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Creates an identity provider for a user pool.
createIdentityProviderRequest
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.DuplicateProviderException
- This exception is thrown when the provider is already supported by the user pool.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateIdentityProviderResponse createIdentityProvider(Consumer<CreateIdentityProviderRequest.Builder> createIdentityProviderRequest) throws InvalidParameterException, DuplicateProviderException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, LimitExceededException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.DuplicateProviderException
- This exception is thrown when the provider is already supported by the user pool.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateResourceServerResponse createResourceServer(CreateResourceServerRequest createResourceServerRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, LimitExceededException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Creates a new OAuth2.0 resource server and defines custom scopes in it.
createResourceServerRequest
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateResourceServerResponse createResourceServer(Consumer<CreateResourceServerRequest.Builder> createResourceServerRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, LimitExceededException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateUserImportJobResponse createUserImportJob(CreateUserImportJobRequest createUserImportJobRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, PreconditionNotMetException, NotAuthorizedException, LimitExceededException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Creates the user import job.
createUserImportJobRequest
- Represents the request to create the user import job.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.PreconditionNotMetException
- This exception is thrown when a precondition is not met.NotAuthorizedException
- This exception is thrown when a user is not authorized.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateUserImportJobResponse createUserImportJob(Consumer<CreateUserImportJobRequest.Builder> createUserImportJobRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, PreconditionNotMetException, NotAuthorizedException, LimitExceededException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.PreconditionNotMetException
- This exception is thrown when a precondition is not met.NotAuthorizedException
- This exception is thrown when a user is not authorized.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateUserPoolResponse createUserPool(CreateUserPoolRequest createUserPoolRequest) throws InvalidParameterException, TooManyRequestsException, LimitExceededException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InvalidEmailRoleAccessPolicyException, NotAuthorizedException, UserPoolTaggingException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Creates a new Amazon Cognito user pool and sets the password policy for the pool.
createUserPoolRequest
- Represents the request to create a user pool.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException
- This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.InvalidEmailRoleAccessPolicyException
- This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code:
400.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserPoolTaggingException
- This exception is thrown when a user pool tag cannot be set or updated.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateUserPoolResponse createUserPool(Consumer<CreateUserPoolRequest.Builder> createUserPoolRequest) throws InvalidParameterException, TooManyRequestsException, LimitExceededException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InvalidEmailRoleAccessPolicyException, NotAuthorizedException, UserPoolTaggingException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException
- This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.InvalidEmailRoleAccessPolicyException
- This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code:
400.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserPoolTaggingException
- This exception is thrown when a user pool tag cannot be set or updated.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateUserPoolClientResponse createUserPoolClient(CreateUserPoolClientRequest createUserPoolClientRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, LimitExceededException, NotAuthorizedException, ScopeDoesNotExistException, InvalidOAuthFlowException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Creates the user pool client.
createUserPoolClientRequest
- Represents the request to create a user pool client.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.NotAuthorizedException
- This exception is thrown when a user is not authorized.ScopeDoesNotExistException
- This exception is thrown when the specified scope does not exist.InvalidOAuthFlowException
- This exception is thrown when the specified OAuth flow is invalid.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateUserPoolClientResponse createUserPoolClient(Consumer<CreateUserPoolClientRequest.Builder> createUserPoolClientRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, LimitExceededException, NotAuthorizedException, ScopeDoesNotExistException, InvalidOAuthFlowException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.NotAuthorizedException
- This exception is thrown when a user is not authorized.ScopeDoesNotExistException
- This exception is thrown when the specified scope does not exist.InvalidOAuthFlowException
- This exception is thrown when the specified OAuth flow is invalid.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateUserPoolDomainResponse createUserPoolDomain(CreateUserPoolDomainRequest createUserPoolDomainRequest) throws InvalidParameterException, NotAuthorizedException, ResourceNotFoundException, LimitExceededException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Creates a new domain for a user pool.
createUserPoolDomainRequest
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException
- This exception is thrown when a user is not authorized.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateUserPoolDomainResponse createUserPoolDomain(Consumer<CreateUserPoolDomainRequest.Builder> createUserPoolDomainRequest) throws InvalidParameterException, NotAuthorizedException, ResourceNotFoundException, LimitExceededException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException
- This exception is thrown when a user is not authorized.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteGroupResponse deleteGroup(DeleteGroupRequest deleteGroupRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Deletes a group. Currently only groups with no members can be deleted.
Calling this action requires developer credentials.
deleteGroupRequest
- ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteGroupResponse deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteIdentityProviderResponse deleteIdentityProvider(DeleteIdentityProviderRequest deleteIdentityProviderRequest) throws InvalidParameterException, UnsupportedIdentityProviderException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Deletes an identity provider for a user pool.
deleteIdentityProviderRequest
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnsupportedIdentityProviderException
- This exception is thrown when the specified identifier is not supported.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteIdentityProviderResponse deleteIdentityProvider(Consumer<DeleteIdentityProviderRequest.Builder> deleteIdentityProviderRequest) throws InvalidParameterException, UnsupportedIdentityProviderException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnsupportedIdentityProviderException
- This exception is thrown when the specified identifier is not supported.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteResourceServerResponse deleteResourceServer(DeleteResourceServerRequest deleteResourceServerRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Deletes a resource server.
deleteResourceServerRequest
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteResourceServerResponse deleteResourceServer(Consumer<DeleteResourceServerRequest.Builder> deleteResourceServerRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Allows a user to delete himself or herself.
deleteUserRequest
- Represents the request to delete a user.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteUserResponse deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteUserAttributesResponse deleteUserAttributes(DeleteUserAttributesRequest deleteUserAttributesRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooMan