@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe 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)
Prevents the user from signing in with the specified external (SAML or social) identity provider (IdP).
|
default AdminDisableProviderForUserResponse |
adminDisableProviderForUser(Consumer<AdminDisableProviderForUserRequest.Builder> adminDisableProviderForUserRequest)
Prevents the user from signing in with the specified external (SAML or social) identity provider (IdP).
|
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 IdP
(SourceUser) based on a specified attribute name and value from the external IdP. |
default AdminLinkProviderForUserResponse |
adminLinkProviderForUser(Consumer<AdminLinkProviderForUserRequest.Builder> adminLinkProviderForUserRequest)
Links an existing user account in a user pool (
DestinationUser) to an identity from an external IdP
(SourceUser) based on a specified attribute name and value from the external IdP. |
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)
A history of user activity and any risks detected as part of Amazon Cognito advanced security.
|
default AdminListUserAuthEventsResponse |
adminListUserAuthEvents(Consumer<AdminListUserAuthEventsRequest.Builder> adminListUserAuthEventsRequest)
A history of user activity and any risks detected as part of Amazon Cognito advanced security.
|
default AdminListUserAuthEventsIterable |
adminListUserAuthEventsPaginator(AdminListUserAuthEventsRequest adminListUserAuthEventsRequest)
A history of user activity and any risks detected as part of Amazon Cognito advanced security.
|
default AdminListUserAuthEventsIterable |
adminListUserAuthEventsPaginator(Consumer<AdminListUserAuthEventsRequest.Builder> adminListUserAuthEventsRequest)
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)
The user's multi-factor authentication (MFA) preference, including which MFA options are activated, and if any
are preferred.
|
default AdminSetUserMfaPreferenceResponse |
adminSetUserMFAPreference(Consumer<AdminSetUserMfaPreferenceRequest.Builder> adminSetUserMfaPreferenceRequest)
The user's multi-factor authentication (MFA) preference, including which MFA options are activated, 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 indicating if it was from a valid user.
|
default AdminUpdateAuthEventFeedbackResponse |
adminUpdateAuthEventFeedback(Consumer<AdminUpdateAuthEventFeedbackRequest.Builder> adminUpdateAuthEventFeedbackRequest)
Provides feedback for an authentication event indicating if 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 a user from all devices.
|
default AdminUserGlobalSignOutResponse |
adminUserGlobalSignOut(Consumer<AdminUserGlobalSignOutRequest.Builder> adminUserGlobalSignOutRequest)
Signs out a user from all devices.
|
default AssociateSoftwareTokenResponse |
associateSoftwareToken(AssociateSoftwareTokenRequest associateSoftwareTokenRequest)
Begins setup of time-based one-time password multi-factor authentication (TOTP MFA) for a user, with a unique
private key that Amazon Cognito generates and returns in the API response.
|
default AssociateSoftwareTokenResponse |
associateSoftwareToken(Consumer<AssociateSoftwareTokenRequest.Builder> associateSoftwareTokenRequest)
Begins setup of time-based one-time password multi-factor authentication (TOTP MFA) for a user, with a unique
private key that Amazon Cognito generates and returns in the API response.
|
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 new user.
|
default ConfirmSignUpResponse |
confirmSignUp(Consumer<ConfirmSignUpRequest.Builder> confirmSignUpRequest)
Confirms registration of a new 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 IdP for a user pool.
|
default CreateIdentityProviderResponse |
createIdentityProvider(CreateIdentityProviderRequest createIdentityProviderRequest)
Creates an IdP for a user pool.
|
default CreateResourceServerResponse |
createResourceServer(Consumer<CreateResourceServerRequest.Builder> createResourceServerRequest)
Creates a new OAuth2.0 resource server and defines custom scopes within it.
|
default CreateResourceServerResponse |
createResourceServer(CreateResourceServerRequest createResourceServerRequest)
Creates a new OAuth2.0 resource server and defines custom scopes within 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 IdP for a user pool.
|
default DeleteIdentityProviderResponse |
deleteIdentityProvider(DeleteIdentityProviderRequest deleteIdentityProviderRequest)
Deletes an IdP 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 IdP.
|
default DescribeIdentityProviderResponse |
describeIdentityProvider(DescribeIdentityProviderRequest describeIdentityProviderRequest)
Gets information about a specific IdP.
|
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 comma-separated value (CSV) file to be used as input for the user import job.
|
default GetCsvHeaderResponse |
getCSVHeader(GetCsvHeaderRequest getCsvHeaderRequest)
Gets the header information for the comma-separated value (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 IdP.
|
default GetIdentityProviderByIdentifierResponse |
getIdentityProviderByIdentifier(GetIdentityProviderByIdentifierRequest getIdentityProviderByIdentifierRequest)
Gets the specified IdP.
|
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 user interface (UI) Customization information for a particular app client's app UI, if any such
information exists for the client.
|
default GetUiCustomizationResponse |
getUICustomization(GetUiCustomizationRequest getUiCustomizationRequest)
Gets the user interface (UI) Customization information for a particular app client's app UI, if any such
information exists for the client.
|
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)
Generates a user attribute verification code for the specified attribute name.
|
default GetUserAttributeVerificationCodeResponse |
getUserAttributeVerificationCode(GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest)
Generates a 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 sign-in for a user in the Amazon Cognito user directory.
|
default InitiateAuthResponse |
initiateAuth(InitiateAuthRequest initiateAuthRequest)
Initiates sign-in for a user in the Amazon Cognito user directory.
|
default ListDevicesResponse |
listDevices(Consumer<ListDevicesRequest.Builder> listDevicesRequest)
Lists the sign-in devices that Amazon Cognito has registered to the current user.
|
default ListDevicesResponse |
listDevices(ListDevicesRequest listDevicesRequest)
Lists the sign-in devices that Amazon Cognito has registered to the current user.
|
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 IdPs for a user pool.
|
default ListIdentityProvidersResponse |
listIdentityProviders(ListIdentityProvidersRequest listIdentityProvidersRequest)
Lists information about all IdPs for a user pool.
|
default ListIdentityProvidersIterable |
listIdentityProvidersPaginator(Consumer<ListIdentityProvidersRequest.Builder> listIdentityProvidersRequest)
Lists information about all IdPs for a user pool.
|
default ListIdentityProvidersIterable |
listIdentityProvidersPaginator(ListIdentityProvidersRequest listIdentityProvidersRequest)
Lists information about all IdPs 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 Amazon Web Services account.
|
default ListUserPoolsResponse |
listUserPools(ListUserPoolsRequest listUserPoolsRequest)
Lists the user pools associated with an Amazon Web Services account.
|
default ListUserPoolsIterable |
listUserPoolsPaginator(Consumer<ListUserPoolsRequest.Builder> listUserPoolsRequest)
Lists the user pools associated with an Amazon Web Services account.
|
default ListUserPoolsIterable |
listUserPoolsPaginator(ListUserPoolsRequest listUserPoolsRequest)
Lists the user pools associated with an Amazon Web Services 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.
|
default RevokeTokenResponse |
revokeToken(Consumer<RevokeTokenRequest.Builder> revokeTokenRequest)
Revokes all of the access tokens generated by the specified refresh token.
|
default RevokeTokenResponse |
revokeToken(RevokeTokenRequest revokeTokenRequest)
Revokes all of the access tokens generated by the specified refresh token.
|
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 user interface (UI) customization information for a user pool's built-in app UI.
|
default SetUiCustomizationResponse |
setUICustomization(SetUiCustomizationRequest setUiCustomizationRequest)
Sets the user interface (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 activated 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 activated and
if any are preferred.
|
default SetUserPoolMfaConfigResponse |
setUserPoolMfaConfig(Consumer<SetUserPoolMfaConfigRequest.Builder> setUserPoolMfaConfigRequest)
Sets the user pool multi-factor authentication (MFA) configuration.
|
default SetUserPoolMfaConfigResponse |
setUserPoolMfaConfig(SetUserPoolMfaConfigRequest setUserPoolMfaConfigRequest)
Sets 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 IdP information for a user pool.
|
default UpdateIdentityProviderResponse |
updateIdentityProvider(UpdateIdentityProviderRequest updateIdentityProviderRequest)
Updates IdP 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 time-based one-time password (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 time-based one-time password (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.
|
serviceNameclosestatic 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 can't 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 isn't authorized.UserImportInProgressException - This exception is thrown when you're 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.AwsServiceExceptiondefault 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 can't 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 isn't authorized.UserImportInProgressException - This exception is thrown when you're 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.AwsServiceExceptiondefault 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 can't 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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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 can't 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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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 can't find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnexpectedLambdaException - This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
Lambda service.NotAuthorizedException - This exception is thrown when a user isn't authorized.TooManyFailedAttemptsException - This exception is thrown when the user has made too many failed attempts for a given action, such as
sign-in.InvalidLambdaResponseException - This exception is thrown when Amazon Cognito encounters an invalid 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 Amazon Web Services resource.UserNotFoundException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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 can't find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnexpectedLambdaException - This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
Lambda service.NotAuthorizedException - This exception is thrown when a user isn't authorized.TooManyFailedAttemptsException - This exception is thrown when the user has made too many failed attempts for a given action, such as
sign-in.InvalidLambdaResponseException - This exception is thrown when Amazon Cognito encounters an invalid 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 Amazon Web Services resource.UserNotFoundException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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 isn't set, the default is to send a welcome message via email or phone (SMS).
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
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 won't 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 can't 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 isn't 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 Amazon Cognito encounters an invalid password.CodeDeliveryFailureException - This exception is thrown when a verification code fails to deliver successfully.UnexpectedLambdaException - This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
Lambda service.InvalidLambdaResponseException - This exception is thrown when Amazon Cognito encounters an invalid 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 doesn't have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is not valid for the role provided for SMS
configuration. This can happen if you don't 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 isn't 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.AwsServiceExceptiondefault 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 isn't set, the default is to send a welcome message via email or phone (SMS).
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
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 won't 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 can't 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 isn't 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 Amazon Cognito encounters an invalid password.CodeDeliveryFailureException - This exception is thrown when a verification code fails to deliver successfully.UnexpectedLambdaException - This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
Lambda service.InvalidLambdaResponseException - This exception is thrown when Amazon Cognito encounters an invalid 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 doesn't have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is not valid for the role provided for SMS
configuration. This can happen if you don't 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 isn't 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.AwsServiceExceptiondefault 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 can't 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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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 can't 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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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 can't 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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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 can't 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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault AdminDisableProviderForUserResponse adminDisableProviderForUser(AdminDisableProviderForUserRequest adminDisableProviderForUserRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, AliasExistsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Prevents the user from signing in with the specified external (SAML or social) identity provider (IdP). If the
user that you want to deactivate is a Amazon Cognito user pools native username + password user, they can't use
their password to sign in. If the user to deactivate is a linked external IdP user, any link between that user
and an existing user is removed. When the external user signs in again, and the user is no longer attached to the
previously linked DestinationUser, the user 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 deactivate a native username + password user, the ProviderName value must be Cognito
and the ProviderAttributeName must be Cognito_Subject. The
ProviderAttributeValue must be the name that is used in the user pool for the user.
The ProviderAttributeName must always be Cognito_Subject for social IdPs. 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 can't 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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't found.AliasExistsException - This exception is thrown when a user tries to confirm the account with an email address or phone number
that has already been supplied as an alias for a different user profile. This exception indicates that an
account with this email address or phone already exists in a user pool that you've configured to use
email address or phone number as a sign-in alias.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.AwsServiceExceptiondefault AdminDisableProviderForUserResponse adminDisableProviderForUser(Consumer<AdminDisableProviderForUserRequest.Builder> adminDisableProviderForUserRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, AliasExistsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Prevents the user from signing in with the specified external (SAML or social) identity provider (IdP). If the
user that you want to deactivate is a Amazon Cognito user pools native username + password user, they can't use
their password to sign in. If the user to deactivate is a linked external IdP user, any link between that user
and an existing user is removed. When the external user signs in again, and the user is no longer attached to the
previously linked DestinationUser, the user 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 deactivate a native username + password user, the ProviderName value must be Cognito
and the ProviderAttributeName must be Cognito_Subject. The
ProviderAttributeValue must be the name that is used in the user pool for the user.
The ProviderAttributeName must always be Cognito_Subject for social IdPs. 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 can't 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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't found.AliasExistsException - This exception is thrown when a user tries to confirm the account with an email address or phone number
that has already been supplied as an alias for a different user profile. This exception indicates that an
account with this email address or phone already exists in a user pool that you've configured to use
email address or phone number as a sign-in alias.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.AwsServiceExceptiondefault 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 the user as an administrator.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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 the user as an administrator.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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 can't 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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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 can't 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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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 can't 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 not valid.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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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 can't 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 not valid.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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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 can't 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 not valid.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 isn't 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.AwsServiceExceptiondefault 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 can't 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 not valid.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 isn't 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.AwsServiceExceptiondefault 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 can't 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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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 can't 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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Calling this action requires developer credentials.
adminInitiateAuthRequest - Initiates the authorization request, as an administrator.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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 Amazon Cognito encounters an unexpected exception with Lambda.InvalidUserPoolConfigurationException - This exception is thrown when the user pool configuration is not valid.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
Lambda service.InvalidLambdaResponseException - This exception is thrown when Amazon Cognito encounters an invalid Lambda response.MfaMethodNotFoundException - This exception is thrown when Amazon Cognito can't find a multi-factor authentication (MFA) method.InvalidSmsRoleAccessPolicyException - This exception is returned when the role provided for SMS configuration doesn't have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is not valid for the role provided for SMS
configuration. This can happen if you don't 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 isn't found.UserNotConfirmedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
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 can't 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 isn't 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 Amazon Cognito encounters an unexpected exception with Lambda.InvalidUserPoolConfigurationException - This exception is thrown when the user pool configuration is not valid.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
Lambda service.InvalidLambdaResponseException - This exception is thrown when Amazon Cognito encounters an invalid Lambda response.MfaMethodNotFoundException - This exception is thrown when Amazon Cognito can't find a multi-factor authentication (MFA) method.InvalidSmsRoleAccessPolicyException - This exception is returned when the role provided for SMS configuration doesn't have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is not valid for the role provided for SMS
configuration. This can happen if you don't 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 isn't found.UserNotConfirmedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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 IdP
(SourceUser) based on a specified attribute name and value from the external IdP. 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. You can then use the federated user identity 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. When the user signs in with a federated user identity, they sign in as the existing user account.
The maximum number of federated identities linked to a user is five.
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 IdPs and provider attributes that have been trusted by the application owner.
This action is administrative and requires developer credentials.
adminLinkProviderForUserRequest - ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't found.AliasExistsException - This exception is thrown when a user tries to confirm the account with an email address or phone number
that has already been supplied as an alias for a different user profile. This exception indicates that an
account with this email address or phone already exists in a user pool that you've configured to use
email address or phone number as a sign-in alias.LimitExceededException - This exception is thrown when a user exceeds the limit for a requested Amazon Web Services 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.AwsServiceExceptiondefault 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 IdP
(SourceUser) based on a specified attribute name and value from the external IdP. 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. You can then use the federated user identity 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. When the user signs in with a federated user identity, they sign in as the existing user account.
The maximum number of federated identities linked to a user is five.
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 IdPs and provider attributes that have been trusted by the application owner.
This action is administrative 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 can't 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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't found.AliasExistsException - This exception is thrown when a user tries to confirm the account with an email address or phone number
that has already been supplied as an alias for a different user profile. This exception indicates that an
account with this email address or phone already exists in a user pool that you've configured to use
email address or phone number as a sign-in alias.LimitExceededException - This exception is thrown when a user exceeds the limit for a requested Amazon Web Services 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.AwsServiceExceptiondefault 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 can't find the requested resource.InvalidUserPoolConfigurationException - This exception is thrown when the user pool configuration is not valid.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 isn't 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.AwsServiceExceptiondefault 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 can't find the requested resource.InvalidUserPoolConfigurationException - This exception is thrown when the user pool configuration is not valid.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 isn't 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.AwsServiceExceptiondefault 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 can't 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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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 can't 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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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 can't 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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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 can't 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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault AdminListUserAuthEventsResponse adminListUserAuthEvents(AdminListUserAuthEventsRequest adminListUserAuthEventsRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, UserPoolAddOnNotEnabledException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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 can't 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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't found.UserPoolAddOnNotEnabledException - This exception is thrown when user pool add-ons aren't 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.AwsServiceExceptiondefault AdminListUserAuthEventsResponse adminListUserAuthEvents(Consumer<AdminListUserAuthEventsRequest.Builder> adminListUserAuthEventsRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, UserPoolAddOnNotEnabledException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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 can't 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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't found.UserPoolAddOnNotEnabledException - This exception is thrown when user pool add-ons aren't 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.AwsServiceExceptiondefault AdminListUserAuthEventsIterable adminListUserAuthEventsPaginator(AdminListUserAuthEventsRequest adminListUserAuthEventsRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, UserPoolAddOnNotEnabledException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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 can't 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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't found.UserPoolAddOnNotEnabledException - This exception is thrown when user pool add-ons aren't 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.AwsServiceExceptiondefault AdminListUserAuthEventsIterable adminListUserAuthEventsPaginator(Consumer<AdminListUserAuthEventsRequest.Builder> adminListUserAuthEventsRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, UserPoolAddOnNotEnabledException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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 can't 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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't found.UserPoolAddOnNotEnabledException - This exception is thrown when user pool add-ons aren't 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.AwsServiceExceptiondefault 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 can't 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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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 can't 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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
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 can't find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnexpectedLambdaException - This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
Lambda service.NotAuthorizedException - This exception is thrown when a user isn't authorized.InvalidLambdaResponseException - This exception is thrown when Amazon Cognito encounters an invalid 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 Amazon Web Services resource.UserNotFoundException - This exception is thrown when a user isn't found.InvalidSmsRoleAccessPolicyException - This exception is returned when the role provided for SMS configuration doesn't have permission to
publish using Amazon SNS.InvalidEmailRoleAccessPolicyException - This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP status code:
400.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is not valid for the role provided for SMS
configuration. This can happen if you don't 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.AwsServiceExceptiondefault 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.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
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 can't find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnexpectedLambdaException - This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
Lambda service.NotAuthorizedException - This exception is thrown when a user isn't authorized.InvalidLambdaResponseException - This exception is thrown when Amazon Cognito encounters an invalid 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 Amazon Web Services resource.UserNotFoundException - This exception is thrown when a user isn't found.InvalidSmsRoleAccessPolicyException - This exception is returned when the role provided for SMS configuration doesn't have permission to
publish using Amazon SNS.InvalidEmailRoleAccessPolicyException - This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP status code:
400.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is not valid for the role provided for SMS
configuration. This can happen if you don't 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.AwsServiceExceptiondefault 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.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
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 can't 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 isn't authorized.CodeMismatchException - This exception is thrown if the provided code doesn't match what the server was expecting.ExpiredCodeException - This exception is thrown if a code has expired.UnexpectedLambdaException - This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.InvalidPasswordException - This exception is thrown when Amazon Cognito encounters an invalid password.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
Lambda service.InvalidLambdaResponseException - This exception is thrown when Amazon Cognito encounters an invalid 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 not valid.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.MfaMethodNotFoundException - This exception is thrown when Amazon Cognito can't find a multi-factor authentication (MFA) method.InvalidSmsRoleAccessPolicyException - This exception is returned when the role provided for SMS configuration doesn't have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is not valid for the role provided for SMS
configuration. This can happen if you don't 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 address or phone number
that has already been supplied as an alias for a different user profile. This exception indicates that an
account with this email address or phone already exists in a user pool that you've configured to use
email address or phone number as a sign-in alias.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user isn't found.UserNotConfirmedException - This exception is thrown when a user isn't confirmed successfully.SoftwareTokenMfaNotFoundException - This exception is thrown when the software token time-based one-time password (TOTP) multi-factor
authentication (MFA) isn't activated 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.AwsServiceExceptiondefault 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.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
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 can't 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 isn't authorized.CodeMismatchException - This exception is thrown if the provided code doesn't match what the server was expecting.ExpiredCodeException - This exception is thrown if a code has expired.UnexpectedLambdaException - This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.InvalidPasswordException - This exception is thrown when Amazon Cognito encounters an invalid password.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
Lambda service.InvalidLambdaResponseException - This exception is thrown when Amazon Cognito encounters an invalid 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 not valid.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.MfaMethodNotFoundException - This exception is thrown when Amazon Cognito can't find a multi-factor authentication (MFA) method.InvalidSmsRoleAccessPolicyException - This exception is returned when the role provided for SMS configuration doesn't have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is not valid for the role provided for SMS
configuration. This can happen if you don't 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 address or phone number
that has already been supplied as an alias for a different user profile. This exception indicates that an
account with this email address or phone already exists in a user pool that you've configured to use
email address or phone number as a sign-in alias.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user isn't found.UserNotConfirmedException - This exception is thrown when a user isn't confirmed successfully.SoftwareTokenMfaNotFoundException - This exception is thrown when the software token time-based one-time password (TOTP) multi-factor
authentication (MFA) isn't activated 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.AwsServiceExceptiondefault AdminSetUserMfaPreferenceResponse adminSetUserMFAPreference(AdminSetUserMfaPreferenceRequest adminSetUserMfaPreferenceRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
The user's multi-factor authentication (MFA) preference, including which MFA options are activated, 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 activated. If multiple options are activated 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 can't 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 isn't authorized.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user isn't found.UserNotConfirmedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault AdminSetUserMfaPreferenceResponse adminSetUserMFAPreference(Consumer<AdminSetUserMfaPreferenceRequest.Builder> adminSetUserMfaPreferenceRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
The user's multi-factor authentication (MFA) preference, including which MFA options are activated, 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 activated. If multiple options are activated 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 can't 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 isn't authorized.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user isn't found.UserNotConfirmedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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 enters 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 doesn't sign in before it
expires, the user won't be able to sign in, and an administrator must reset their password.
Once the user has set a new password, or the password is permanent, the user status is set to
Confirmed.
adminSetUserPasswordRequest - ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't authorized.UserNotFoundException - This exception is thrown when a user isn't 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 Amazon Cognito 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.AwsServiceExceptiondefault 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 enters 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 doesn't sign in before it
expires, the user won't be able to sign in, and an administrator must reset their password.
Once the user has set a new password, or the password is permanent, the user status is 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 can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't authorized.UserNotFoundException - This exception is thrown when a user isn't 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 Amazon Cognito 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.AwsServiceExceptiondefault 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 time-based one-time password (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 can't 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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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 time-based one-time password (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 can't 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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault AdminUpdateAuthEventFeedbackResponse adminUpdateAuthEventFeedback(AdminUpdateAuthEventFeedbackRequest adminUpdateAuthEventFeedbackRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, UserPoolAddOnNotEnabledException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Provides feedback for an authentication event indicating if 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 can't 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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't found.UserPoolAddOnNotEnabledException - This exception is thrown when user pool add-ons aren't 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.AwsServiceExceptiondefault AdminUpdateAuthEventFeedbackResponse adminUpdateAuthEventFeedback(Consumer<AdminUpdateAuthEventFeedbackRequest.Builder> adminUpdateAuthEventFeedbackRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, UserPoolAddOnNotEnabledException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Provides feedback for an authentication event indicating if 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 can't 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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't found.UserPoolAddOnNotEnabledException - This exception is thrown when user pool add-ons aren't 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.AwsServiceExceptiondefault 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 can't find the requested resource.InvalidUserPoolConfigurationException - This exception is thrown when the user pool configuration is not valid.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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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 can't find the requested resource.InvalidUserPoolConfigurationException - This exception is thrown when the user pool configuration is not valid.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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
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 can't find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnexpectedLambdaException - This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
Lambda service.InvalidLambdaResponseException - This exception is thrown when Amazon Cognito encounters an invalid Lambda response.AliasExistsException - This exception is thrown when a user tries to confirm the account with an email address or phone number
that has already been supplied as an alias for a different user profile. This exception indicates that an
account with this email address or phone already exists in a user pool that you've configured to use
email address or phone number as a sign-in alias.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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't 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 doesn't have permission to
publish using Amazon SNS.InvalidEmailRoleAccessPolicyException - This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP status code:
400.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is not valid for the role provided for SMS
configuration. This can happen if you don't 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.AwsServiceExceptiondefault 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.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
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 can't find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnexpectedLambdaException - This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
Lambda service.InvalidLambdaResponseException - This exception is thrown when Amazon Cognito encounters an invalid Lambda response.AliasExistsException - This exception is thrown when a user tries to confirm the account with an email address or phone number
that has already been supplied as an alias for a different user profile. This exception indicates that an
account with this email address or phone already exists in a user pool that you've configured to use
email address or phone number as a sign-in alias.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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't 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 doesn't have permission to
publish using Amazon SNS.InvalidEmailRoleAccessPolicyException - This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP status code:
400.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is not valid for the role provided for SMS
configuration. This can happen if you don't 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.AwsServiceExceptiondefault AdminUserGlobalSignOutResponse adminUserGlobalSignOut(AdminUserGlobalSignOutRequest adminUserGlobalSignOutRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Signs out a user from all devices. You must sign AdminUserGlobalSignOut requests with Amazon Web
Services credentials. It also invalidates all refresh tokens that Amazon Cognito has issued to a user. The user's
current access and ID tokens remain valid until they expire. By default, access and ID tokens expire one hour
after they're issued. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the
cookie validity period of 1 hour.
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 can't 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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault AdminUserGlobalSignOutResponse adminUserGlobalSignOut(Consumer<AdminUserGlobalSignOutRequest.Builder> adminUserGlobalSignOutRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Signs out a user from all devices. You must sign AdminUserGlobalSignOut requests with Amazon Web
Services credentials. It also invalidates all refresh tokens that Amazon Cognito has issued to a user. The user's
current access and ID tokens remain valid until they expire. By default, access and ID tokens expire one hour
after they're issued. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the
cookie validity period of 1 hour.
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 can't 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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault AssociateSoftwareTokenResponse associateSoftwareToken(AssociateSoftwareTokenRequest associateSoftwareTokenRequest) throws ConcurrentModificationException, InvalidParameterException, NotAuthorizedException, ResourceNotFoundException, InternalErrorException, SoftwareTokenMfaNotFoundException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Begins setup of time-based one-time password multi-factor authentication (TOTP MFA) for a user, with a unique
private key that Amazon Cognito generates and returns in the API response. You can authorize an
AssociateSoftwareToken request with either the user's access token, or a session string from a
challenge response that you received from Amazon Cognito.
Amazon Cognito disassociates an existing software token when you verify the new token in a
VerifySoftwareToken API request. If you don't verify the software token and your user pool doesn't require
MFA, the user can then authenticate with user name and password credentials alone. If your user pool requires
TOTP MFA, Amazon Cognito generates an MFA_SETUP or SOFTWARE_TOKEN_SETUP challenge each
time your user signs. Complete setup with AssociateSoftwareToken and
VerifySoftwareToken.
After you set up software token MFA for your user, Amazon Cognito generates a SOFTWARE_TOKEN_MFA
challenge when they authenticate. Respond to this challenge with your user's TOTP.
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 isn't authorized.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 time-based one-time password (TOTP) multi-factor
authentication (MFA) isn't activated 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.AwsServiceExceptiondefault AssociateSoftwareTokenResponse associateSoftwareToken(Consumer<AssociateSoftwareTokenRequest.Builder> associateSoftwareTokenRequest) throws ConcurrentModificationException, InvalidParameterException, NotAuthorizedException, ResourceNotFoundException, InternalErrorException, SoftwareTokenMfaNotFoundException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Begins setup of time-based one-time password multi-factor authentication (TOTP MFA) for a user, with a unique
private key that Amazon Cognito generates and returns in the API response. You can authorize an
AssociateSoftwareToken request with either the user's access token, or a session string from a
challenge response that you received from Amazon Cognito.
Amazon Cognito disassociates an existing software token when you verify the new token in a
VerifySoftwareToken API request. If you don't verify the software token and your user pool doesn't require
MFA, the user can then authenticate with user name and password credentials alone. If your user pool requires
TOTP MFA, Amazon Cognito generates an MFA_SETUP or SOFTWARE_TOKEN_SETUP challenge each
time your user signs. Complete setup with AssociateSoftwareToken and
VerifySoftwareToken.
After you set up software token MFA for your user, Amazon Cognito generates a SOFTWARE_TOKEN_MFA
challenge when they authenticate. Respond to this challenge with your user's TOTP.
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 isn't authorized.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 time-based one-time password (TOTP) multi-factor
authentication (MFA) isn't activated 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.AwsServiceExceptiondefault 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 can't find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.InvalidPasswordException - This exception is thrown when Amazon Cognito encounters an invalid password.NotAuthorizedException - This exception is thrown when a user isn't 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 Amazon Web Services resource.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user isn't found.UserNotConfirmedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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 can't find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.InvalidPasswordException - This exception is thrown when Amazon Cognito encounters an invalid password.NotAuthorizedException - This exception is thrown when a user isn't 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 Amazon Web Services resource.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user isn't found.UserNotConfirmedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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 can't 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 isn't authorized.InvalidPasswordException - This exception is thrown when Amazon Cognito encounters an invalid password.InvalidLambdaResponseException - This exception is thrown when Amazon Cognito encounters an invalid 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 not valid.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 isn't found.UserNotConfirmedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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 can't 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 isn't authorized.InvalidPasswordException - This exception is thrown when Amazon Cognito encounters an invalid password.InvalidLambdaResponseException - This exception is thrown when Amazon Cognito encounters an invalid 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 not valid.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 isn't found.UserNotConfirmedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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 can't find the requested resource.UnexpectedLambdaException - This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
Lambda service.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.InvalidPasswordException - This exception is thrown when Amazon Cognito encounters an invalid password.NotAuthorizedException - This exception is thrown when a user isn't authorized.CodeMismatchException - This exception is thrown if the provided code doesn't 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, such as
sign-in.InvalidLambdaResponseException - This exception is thrown when Amazon Cognito encounters an invalid 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 Amazon Web Services resource.UserNotFoundException - This exception is thrown when a user isn't found.UserNotConfirmedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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 can't find the requested resource.UnexpectedLambdaException - This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
Lambda service.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.InvalidPasswordException - This exception is thrown when Amazon Cognito encounters an invalid password.NotAuthorizedException - This exception is thrown when a user isn't authorized.CodeMismatchException - This exception is thrown if the provided code doesn't 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, such as
sign-in.InvalidLambdaResponseException - This exception is thrown when Amazon Cognito encounters an invalid 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 Amazon Web Services resource.UserNotFoundException - This exception is thrown when a user isn't found.UserNotConfirmedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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 new user.
confirmSignUpRequest - Represents the request to confirm registration of a user.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnexpectedLambdaException - This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
Lambda service.NotAuthorizedException - This exception is thrown when a user isn't authorized.TooManyFailedAttemptsException - This exception is thrown when the user has made too many failed attempts for a given action, such as
sign-in.CodeMismatchException - This exception is thrown if the provided code doesn't match what the server was expecting.ExpiredCodeException - This exception is thrown if a code has expired.InvalidLambdaResponseException - This exception is thrown when Amazon Cognito encounters an invalid Lambda response.AliasExistsException - This exception is thrown when a user tries to confirm the account with an email address or phone number
that has already been supplied as an alias for a different user profile. This exception indicates that an
account with this email address or phone already exists in a user pool that you've configured to use
email address or phone number as a sign-in alias.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 Amazon Web Services resource.UserNotFoundException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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 new 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 can't find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnexpectedLambdaException - This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
Lambda service.NotAuthorizedException - This exception is thrown when a user isn't authorized.TooManyFailedAttemptsException - This exception is thrown when the user has made too many failed attempts for a given action, such as
sign-in.CodeMismatchException - This exception is thrown if the provided code doesn't match what the server was expecting.ExpiredCodeException - This exception is thrown if a code has expired.InvalidLambdaResponseException - This exception is thrown when Amazon Cognito encounters an invalid Lambda response.AliasExistsException - This exception is thrown when a user tries to confirm the account with an email address or phone number
that has already been supplied as an alias for a different user profile. This exception indicates that an
account with this email address or phone already exists in a user pool that you've configured to use
email address or phone number as a sign-in alias.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 Amazon Web Services resource.UserNotFoundException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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 can't 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 Amazon Web Services resource.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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 can't 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 Amazon Web Services resource.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault CreateIdentityProviderResponse createIdentityProvider(CreateIdentityProviderRequest createIdentityProviderRequest) throws InvalidParameterException, DuplicateProviderException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, LimitExceededException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Creates an IdP 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 can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't 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 Amazon Web Services 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.AwsServiceExceptiondefault CreateIdentityProviderResponse createIdentityProvider(Consumer<CreateIdentityProviderRequest.Builder> createIdentityProviderRequest) throws InvalidParameterException, DuplicateProviderException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, LimitExceededException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Creates an IdP 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 can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't 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 Amazon Web Services 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.AwsServiceExceptiondefault 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 within 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 can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't 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 Amazon Web Services 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.AwsServiceExceptiondefault 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 within 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 can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't 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 Amazon Web Services 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.AwsServiceExceptiondefault 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 can't 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 isn't authorized.LimitExceededException - This exception is thrown when a user exceeds the limit for a requested Amazon Web Services 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.AwsServiceExceptiondefault 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 can't 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 isn't authorized.LimitExceededException - This exception is thrown when a user exceeds the limit for a requested Amazon Web Services 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.AwsServiceExceptiondefault 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.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
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 Amazon Web Services resource.InvalidSmsRoleAccessPolicyException - This exception is returned when the role provided for SMS configuration doesn't have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is not valid for the role provided for SMS
configuration. This can happen if you don't 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 isn't allowed to use your email identity. HTTP status code:
400.NotAuthorizedException - This exception is thrown when a user isn't authorized.UserPoolTaggingException - This exception is thrown when a user pool tag can't 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.AwsServiceExceptiondefault 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 action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
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 Amazon Web Services resource.InvalidSmsRoleAccessPolicyException - This exception is returned when the role provided for SMS configuration doesn't have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is not valid for the role provided for SMS
configuration. This can happen if you don't 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 isn't allowed to use your email identity. HTTP status code:
400.NotAuthorizedException - This exception is thrown when a user isn't authorized.UserPoolTaggingException - This exception is thrown when a user pool tag can't 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.AwsServiceExceptiondefault CreateUserPoolClientResponse createUserPoolClient(CreateUserPoolClientRequest createUserPoolClientRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, LimitExceededException, NotAuthorizedException, ScopeDoesNotExistException, InvalidOAuthFlowException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Creates the user pool client.
When you create a new user pool client, token revocation is automatically activated. For more information about revoking tokens, see RevokeToken.
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 can't 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 Amazon Web Services resource.NotAuthorizedException - This exception is thrown when a user isn't authorized.ScopeDoesNotExistException - This exception is thrown when the specified scope doesn't exist.InvalidOAuthFlowException - This exception is thrown when the specified OAuth flow is not valid.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.AwsServiceExceptiondefault CreateUserPoolClientResponse createUserPoolClient(Consumer<CreateUserPoolClientRequest.Builder> createUserPoolClientRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, LimitExceededException, NotAuthorizedException, ScopeDoesNotExistException, InvalidOAuthFlowException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Creates the user pool client.
When you create a new user pool client, token revocation is automatically activated. For more information about revoking tokens, see RevokeToken.
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 can't 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 Amazon Web Services resource.NotAuthorizedException - This exception is thrown when a user isn't authorized.ScopeDoesNotExistException - This exception is thrown when the specified scope doesn't exist.InvalidOAuthFlowException - This exception is thrown when the specified OAuth flow is not valid.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.AwsServiceExceptiondefault 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 isn't authorized.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.LimitExceededException - This exception is thrown when a user exceeds the limit for a requested Amazon Web Services 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.AwsServiceExceptiondefault 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 isn't authorized.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.LimitExceededException - This exception is thrown when a user exceeds the limit for a requested Amazon Web Services 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.AwsServiceExceptiondefault DeleteGroupResponse deleteGroup(DeleteGroupRequest deleteGroupRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Deletes a group.
Calling this action requires developer credentials.
deleteGroupRequest - ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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.AwsServiceExceptiondefault DeleteGroupResponse deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Deletes a group.
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 can't 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 isn't 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.AwsServiceExceptiondefault DeleteIdentityProviderResponse deleteIdentityProvider(DeleteIdentityProviderRequest deleteIdentityProviderRequest) throws InvalidParameterException, UnsupportedIdentityProviderException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Deletes an IdP 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 isn't supported.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault DeleteIdentityProviderResponse deleteIdentityProvider(Consumer<DeleteIdentityProviderRequest.Builder> deleteIdentityProviderRequest) throws InvalidParameterException, UnsupportedIdentityProviderException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Deletes an IdP 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 isn't supported.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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 can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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 can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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 can't 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 isn't 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 isn't found.UserNotConfirmedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault 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 can't 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 isn't 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 isn't found.UserNotConfirmedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault DeleteUserAttributesResponse deleteUserAttributes(DeleteUserAttributesRequest deleteUserAttributesRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Deletes the attributes for a user.
deleteUserAttributesRequest - Represents the request to delete user attributes.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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 isn't found.UserNotConfirmedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault DeleteUserAttributesResponse deleteUserAttributes(Consumer<DeleteUserAttributesRequest.Builder> deleteUserAttributesRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Deletes the attributes for a user.
This is a convenience which creates an instance of the DeleteUserAttributesRequest.Builder avoiding the
need to create one manually via DeleteUserAttributesRequest.builder()
deleteUserAttributesRequest - A Consumer that will call methods on DeleteUserAttributesRequest.Builder to create a
request. Represents the request to delete user attributes.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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 isn't found.UserNotConfirmedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault DeleteUserPoolResponse deleteUserPool(DeleteUserPoolRequest deleteUserPoolRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserImportInProgressException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Deletes the specified Amazon Cognito user pool.
deleteUserPoolRequest - Represents the request to delete a user pool.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't authorized.UserImportInProgressException - This exception is thrown when you're 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.AwsServiceExceptiondefault DeleteUserPoolResponse deleteUserPool(Consumer<DeleteUserPoolRequest.Builder> deleteUserPoolRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserImportInProgressException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Deletes the specified Amazon Cognito user pool.
This is a convenience which creates an instance of the DeleteUserPoolRequest.Builder avoiding the need to
create one manually via DeleteUserPoolRequest.builder()
deleteUserPoolRequest - A Consumer that will call methods on DeleteUserPoolRequest.Builder to create a request.
Represents the request to delete a user pool.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't authorized.UserImportInProgressException - This exception is thrown when you're 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.AwsServiceExceptiondefault DeleteUserPoolClientResponse deleteUserPoolClient(DeleteUserPoolClientRequest deleteUserPoolClientRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Allows the developer to delete the user pool client.
deleteUserPoolClientRequest - Represents the request to delete a user pool client.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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.AwsServiceExceptiondefault DeleteUserPoolClientResponse deleteUserPoolClient(Consumer<DeleteUserPoolClientRequest.Builder> deleteUserPoolClientRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Allows the developer to delete the user pool client.
This is a convenience which creates an instance of the DeleteUserPoolClientRequest.Builder avoiding the
need to create one manually via DeleteUserPoolClientRequest.builder()
deleteUserPoolClientRequest - A Consumer that will call methods on DeleteUserPoolClientRequest.Builder to create a
request. Represents the request to delete a user pool client.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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.AwsServiceExceptiondefault DeleteUserPoolDomainResponse deleteUserPoolDomain(DeleteUserPoolDomainRequest deleteUserPoolDomainRequest) throws NotAuthorizedException, InvalidParameterException, ResourceNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Deletes a domain for a user pool.
deleteUserPoolDomainRequest - NotAuthorizedException - This exception is thrown when a user isn't authorized.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested 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.AwsServiceExceptiondefault DeleteUserPoolDomainResponse deleteUserPoolDomain(Consumer<DeleteUserPoolDomainRequest.Builder> deleteUserPoolDomainRequest) throws NotAuthorizedException, InvalidParameterException, ResourceNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Deletes a domain for a user pool.
This is a convenience which creates an instance of the DeleteUserPoolDomainRequest.Builder avoiding the
need to create one manually via DeleteUserPoolDomainRequest.builder()
deleteUserPoolDomainRequest - A Consumer that will call methods on DeleteUserPoolDomainRequest.Builder to create a
request.NotAuthorizedException - This exception is thrown when a user isn't authorized.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested 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.AwsServiceExceptiondefault DescribeIdentityProviderResponse describeIdentityProvider(DescribeIdentityProviderRequest describeIdentityProviderRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Gets information about a specific IdP.
describeIdentityProviderRequest - InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault DescribeIdentityProviderResponse describeIdentityProvider(Consumer<DescribeIdentityProviderRequest.Builder> describeIdentityProviderRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Gets information about a specific IdP.
This is a convenience which creates an instance of the DescribeIdentityProviderRequest.Builder avoiding
the need to create one manually via DescribeIdentityProviderRequest.builder()
describeIdentityProviderRequest - A Consumer that will call methods on DescribeIdentityProviderRequest.Builder to create a
request.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault DescribeResourceServerResponse describeResourceServer(DescribeResourceServerRequest describeResourceServerRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Describes a resource server.
describeResourceServerRequest - InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault DescribeResourceServerResponse describeResourceServer(Consumer<DescribeResourceServerRequest.Builder> describeResourceServerRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Describes a resource server.
This is a convenience which creates an instance of the DescribeResourceServerRequest.Builder avoiding the
need to create one manually via DescribeResourceServerRequest.builder()
describeResourceServerRequest - A Consumer that will call methods on DescribeResourceServerRequest.Builder to create a
request.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault DescribeRiskConfigurationResponse describeRiskConfiguration(DescribeRiskConfigurationRequest describeRiskConfigurationRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserPoolAddOnNotEnabledException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Describes the risk configuration.
describeRiskConfigurationRequest - ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't authorized.UserPoolAddOnNotEnabledException - This exception is thrown when user pool add-ons aren't 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.AwsServiceExceptiondefault DescribeRiskConfigurationResponse describeRiskConfiguration(Consumer<DescribeRiskConfigurationRequest.Builder> describeRiskConfigurationRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserPoolAddOnNotEnabledException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Describes the risk configuration.
This is a convenience which creates an instance of the DescribeRiskConfigurationRequest.Builder avoiding
the need to create one manually via DescribeRiskConfigurationRequest.builder()
describeRiskConfigurationRequest - A Consumer that will call methods on DescribeRiskConfigurationRequest.Builder to create a
request.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't authorized.UserPoolAddOnNotEnabledException - This exception is thrown when user pool add-ons aren't 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.AwsServiceExceptiondefault DescribeUserImportJobResponse describeUserImportJob(DescribeUserImportJobRequest describeUserImportJobRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Describes the user import job.
describeUserImportJobRequest - Represents the request to describe the user import job.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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.AwsServiceExceptiondefault DescribeUserImportJobResponse describeUserImportJob(Consumer<DescribeUserImportJobRequest.Builder> describeUserImportJobRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Describes the user import job.
This is a convenience which creates an instance of the DescribeUserImportJobRequest.Builder avoiding the
need to create one manually via DescribeUserImportJobRequest.builder()
describeUserImportJobRequest - A Consumer that will call methods on DescribeUserImportJobRequest.Builder to create a
request. Represents the request to describe the user import job.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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.AwsServiceExceptiondefault DescribeUserPoolResponse describeUserPool(DescribeUserPoolRequest describeUserPoolRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserPoolTaggingException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Returns the configuration information and metadata of the specified user pool.
describeUserPoolRequest - Represents the request to describe the user pool.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't authorized.UserPoolTaggingException - This exception is thrown when a user pool tag can't 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.AwsServiceExceptiondefault DescribeUserPoolResponse describeUserPool(Consumer<DescribeUserPoolRequest.Builder> describeUserPoolRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserPoolTaggingException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Returns the configuration information and metadata of the specified user pool.
This is a convenience which creates an instance of the DescribeUserPoolRequest.Builder avoiding the need
to create one manually via DescribeUserPoolRequest.builder()
describeUserPoolRequest - A Consumer that will call methods on DescribeUserPoolRequest.Builder to create a request.
Represents the request to describe the user pool.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't authorized.UserPoolTaggingException - This exception is thrown when a user pool tag can't 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.AwsServiceExceptiondefault DescribeUserPoolClientResponse describeUserPoolClient(DescribeUserPoolClientRequest describeUserPoolClientRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Client method for returning the configuration information and metadata of the specified user pool app client.
describeUserPoolClientRequest - Represents the request to describe a user pool client.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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.AwsServiceExceptiondefault DescribeUserPoolClientResponse describeUserPoolClient(Consumer<DescribeUserPoolClientRequest.Builder> describeUserPoolClientRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Client method for returning the configuration information and metadata of the specified user pool app client.
This is a convenience which creates an instance of the DescribeUserPoolClientRequest.Builder avoiding the
need to create one manually via DescribeUserPoolClientRequest.builder()
describeUserPoolClientRequest - A Consumer that will call methods on DescribeUserPoolClientRequest.Builder to create a
request. Represents the request to describe a user pool client.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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.AwsServiceExceptiondefault DescribeUserPoolDomainResponse describeUserPoolDomain(DescribeUserPoolDomainRequest describeUserPoolDomainRequest) throws NotAuthorizedException, InvalidParameterException, ResourceNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Gets information about a domain.
describeUserPoolDomainRequest - NotAuthorizedException - This exception is thrown when a user isn't authorized.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested 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.AwsServiceExceptiondefault DescribeUserPoolDomainResponse describeUserPoolDomain(Consumer<DescribeUserPoolDomainRequest.Builder> describeUserPoolDomainRequest) throws NotAuthorizedException, InvalidParameterException, ResourceNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Gets information about a domain.
This is a convenience which creates an instance of the DescribeUserPoolDomainRequest.Builder avoiding the
need to create one manually via DescribeUserPoolDomainRequest.builder()
describeUserPoolDomainRequest - A Consumer that will call methods on DescribeUserPoolDomainRequest.Builder to create a
request.NotAuthorizedException - This exception is thrown when a user isn't authorized.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested 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.AwsServiceExceptiondefault ForgetDeviceResponse forgetDevice(ForgetDeviceRequest forgetDeviceRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, InvalidUserPoolConfigurationException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Forgets the specified device.
forgetDeviceRequest - Represents the request to forget the device.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't authorized.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 not valid.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user isn't found.UserNotConfirmedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault ForgetDeviceResponse forgetDevice(Consumer<ForgetDeviceRequest.Builder> forgetDeviceRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, InvalidUserPoolConfigurationException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Forgets the specified device.
This is a convenience which creates an instance of the ForgetDeviceRequest.Builder avoiding the need to
create one manually via ForgetDeviceRequest.builder()
forgetDeviceRequest - A Consumer that will call methods on ForgetDeviceRequest.Builder to create a request.
Represents the request to forget the device.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't authorized.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 not valid.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user isn't found.UserNotConfirmedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault ForgotPasswordResponse forgotPassword(ForgotPasswordRequest forgotPasswordRequest) throws ResourceNotFoundException, InvalidParameterException, UnexpectedLambdaException, UserLambdaValidationException, NotAuthorizedException, InvalidLambdaResponseException, TooManyRequestsException, LimitExceededException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InvalidEmailRoleAccessPolicyException, CodeDeliveryFailureException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Calling this API causes a message to be sent to the end user with a confirmation code that is required to change
the user's password. For the Username parameter, you can use the username or user alias. The method
used to send the confirmation code is sent according to the specified AccountRecoverySetting. For more
information, see Recovering
User Accounts in the Amazon Cognito Developer Guide. If neither a verified phone number nor a verified
email exists, an InvalidParameterException is thrown. To use the confirmation code for resetting the
password, call ConfirmForgotPassword.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
forgotPasswordRequest - Represents the request to reset a user's password.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnexpectedLambdaException - This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
Lambda service.NotAuthorizedException - This exception is thrown when a user isn't authorized.InvalidLambdaResponseException - This exception is thrown when Amazon Cognito encounters an invalid 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 Amazon Web Services resource.InvalidSmsRoleAccessPolicyException - This exception is returned when the role provided for SMS configuration doesn't have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is not valid for the role provided for SMS
configuration. This can happen if you don't 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 isn't allowed to use your email identity. HTTP status code:
400.CodeDeliveryFailureException - This exception is thrown when a verification code fails to deliver successfully.UserNotFoundException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault ForgotPasswordResponse forgotPassword(Consumer<ForgotPasswordRequest.Builder> forgotPasswordRequest) throws ResourceNotFoundException, InvalidParameterException, UnexpectedLambdaException, UserLambdaValidationException, NotAuthorizedException, InvalidLambdaResponseException, TooManyRequestsException, LimitExceededException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InvalidEmailRoleAccessPolicyException, CodeDeliveryFailureException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Calling this API causes a message to be sent to the end user with a confirmation code that is required to change
the user's password. For the Username parameter, you can use the username or user alias. The method
used to send the confirmation code is sent according to the specified AccountRecoverySetting. For more
information, see Recovering
User Accounts in the Amazon Cognito Developer Guide. If neither a verified phone number nor a verified
email exists, an InvalidParameterException is thrown. To use the confirmation code for resetting the
password, call ConfirmForgotPassword.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
This is a convenience which creates an instance of the ForgotPasswordRequest.Builder avoiding the need to
create one manually via ForgotPasswordRequest.builder()
forgotPasswordRequest - A Consumer that will call methods on ForgotPasswordRequest.Builder to create a request.
Represents the request to reset a user's password.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnexpectedLambdaException - This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
Lambda service.NotAuthorizedException - This exception is thrown when a user isn't authorized.InvalidLambdaResponseException - This exception is thrown when Amazon Cognito encounters an invalid 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 Amazon Web Services resource.InvalidSmsRoleAccessPolicyException - This exception is returned when the role provided for SMS configuration doesn't have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is not valid for the role provided for SMS
configuration. This can happen if you don't 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 isn't allowed to use your email identity. HTTP status code:
400.CodeDeliveryFailureException - This exception is thrown when a verification code fails to deliver successfully.UserNotFoundException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault GetCsvHeaderResponse getCSVHeader(GetCsvHeaderRequest getCsvHeaderRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Gets the header information for the comma-separated value (CSV) file to be used as input for the user import job.
getCsvHeaderRequest - Represents the request to get the header information of the CSV file for the user import job.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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.AwsServiceExceptiondefault GetCsvHeaderResponse getCSVHeader(Consumer<GetCsvHeaderRequest.Builder> getCsvHeaderRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Gets the header information for the comma-separated value (CSV) file to be used as input for the user import job.
This is a convenience which creates an instance of the GetCsvHeaderRequest.Builder avoiding the need to
create one manually via GetCsvHeaderRequest.builder()
getCsvHeaderRequest - A Consumer that will call methods on GetCSVHeaderRequest.Builder to create a request.
Represents the request to get the header information of the CSV file for the user import job.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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.AwsServiceExceptiondefault GetDeviceResponse getDevice(GetDeviceRequest getDeviceRequest) throws ResourceNotFoundException, InvalidParameterException, InvalidUserPoolConfigurationException, NotAuthorizedException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Gets the device.
getDeviceRequest - Represents the request to get the device.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 not valid.NotAuthorizedException - This exception is thrown when a user isn't 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 isn't found.UserNotConfirmedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault GetDeviceResponse getDevice(Consumer<GetDeviceRequest.Builder> getDeviceRequest) throws ResourceNotFoundException, InvalidParameterException, InvalidUserPoolConfigurationException, NotAuthorizedException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Gets the device.
This is a convenience which creates an instance of the GetDeviceRequest.Builder avoiding the need to
create one manually via GetDeviceRequest.builder()
getDeviceRequest - A Consumer that will call methods on GetDeviceRequest.Builder to create a request.
Represents the request to get the device.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 not valid.NotAuthorizedException - This exception is thrown when a user isn't 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 isn't found.UserNotConfirmedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault GetGroupResponse getGroup(GetGroupRequest getGroupRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Gets a group.
Calling this action requires developer credentials.
getGroupRequest - ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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.AwsServiceExceptiondefault GetGroupResponse getGroup(Consumer<GetGroupRequest.Builder> getGroupRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Gets a group.
Calling this action requires developer credentials.
This is a convenience which creates an instance of the GetGroupRequest.Builder avoiding the need to
create one manually via GetGroupRequest.builder()
getGroupRequest - A Consumer that will call methods on GetGroupRequest.Builder to create a request.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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.AwsServiceExceptiondefault GetIdentityProviderByIdentifierResponse getIdentityProviderByIdentifier(GetIdentityProviderByIdentifierRequest getIdentityProviderByIdentifierRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Gets the specified IdP.
getIdentityProviderByIdentifierRequest - InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault GetIdentityProviderByIdentifierResponse getIdentityProviderByIdentifier(Consumer<GetIdentityProviderByIdentifierRequest.Builder> getIdentityProviderByIdentifierRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Gets the specified IdP.
This is a convenience which creates an instance of the GetIdentityProviderByIdentifierRequest.Builder
avoiding the need to create one manually via GetIdentityProviderByIdentifierRequest.builder()
getIdentityProviderByIdentifierRequest - A Consumer that will call methods on GetIdentityProviderByIdentifierRequest.Builder to
create a request.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault GetSigningCertificateResponse getSigningCertificate(GetSigningCertificateRequest getSigningCertificateRequest) throws InternalErrorException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
This method takes a user pool ID, and returns the signing certificate.
getSigningCertificateRequest - Request to get a signing certificate from Amazon Cognito.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.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.AwsServiceExceptiondefault GetSigningCertificateResponse getSigningCertificate(Consumer<GetSigningCertificateRequest.Builder> getSigningCertificateRequest) throws InternalErrorException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
This method takes a user pool ID, and returns the signing certificate.
This is a convenience which creates an instance of the GetSigningCertificateRequest.Builder avoiding the
need to create one manually via GetSigningCertificateRequest.builder()
getSigningCertificateRequest - A Consumer that will call methods on GetSigningCertificateRequest.Builder to create a
request. Request to get a signing certificate from Amazon Cognito.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.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.AwsServiceExceptiondefault GetUiCustomizationResponse getUICustomization(GetUiCustomizationRequest getUiCustomizationRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Gets the user interface (UI) Customization information for a particular app client's app UI, if any such
information exists for the client. If nothing is set for the particular client, but there is an existing pool
level customization (the app clientId is ALL), then that information is returned. If
nothing is present, then an empty shape is returned.
getUiCustomizationRequest - InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault GetUiCustomizationResponse getUICustomization(Consumer<GetUiCustomizationRequest.Builder> getUiCustomizationRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Gets the user interface (UI) Customization information for a particular app client's app UI, if any such
information exists for the client. If nothing is set for the particular client, but there is an existing pool
level customization (the app clientId is ALL), then that information is returned. If
nothing is present, then an empty shape is returned.
This is a convenience which creates an instance of the GetUiCustomizationRequest.Builder avoiding the
need to create one manually via GetUiCustomizationRequest.builder()
getUiCustomizationRequest - A Consumer that will call methods on GetUICustomizationRequest.Builder to create a
request.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault GetUserResponse getUser(GetUserRequest getUserRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Gets the user attributes and metadata for a user.
getUserRequest - Represents the request to get information about the user.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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 isn't found.UserNotConfirmedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault GetUserResponse getUser(Consumer<GetUserRequest.Builder> getUserRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Gets the user attributes and metadata for a user.
This is a convenience which creates an instance of the GetUserRequest.Builder avoiding the need to create
one manually via GetUserRequest.builder()
getUserRequest - A Consumer that will call methods on GetUserRequest.Builder to create a request.
Represents the request to get information about the user.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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 isn't found.UserNotConfirmedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault GetUserAttributeVerificationCodeResponse getUserAttributeVerificationCode(GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UnexpectedLambdaException, UserLambdaValidationException, InvalidLambdaResponseException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InvalidEmailRoleAccessPolicyException, CodeDeliveryFailureException, LimitExceededException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Generates a user attribute verification code for the specified attribute name. Sends a message to a user with a code that they must return in a VerifyUserAttribute request.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
getUserAttributeVerificationCodeRequest - Represents the request to get user attribute verification.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't authorized.UnexpectedLambdaException - This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
Lambda service.InvalidLambdaResponseException - This exception is thrown when Amazon Cognito encounters an invalid Lambda response.InvalidSmsRoleAccessPolicyException - This exception is returned when the role provided for SMS configuration doesn't have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is not valid for the role provided for SMS
configuration. This can happen if you don't 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 isn't allowed to use your email identity. HTTP status code:
400.CodeDeliveryFailureException - This exception is thrown when a verification code fails to deliver successfully.LimitExceededException - This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user isn't found.UserNotConfirmedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault GetUserAttributeVerificationCodeResponse getUserAttributeVerificationCode(Consumer<GetUserAttributeVerificationCodeRequest.Builder> getUserAttributeVerificationCodeRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UnexpectedLambdaException, UserLambdaValidationException, InvalidLambdaResponseException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InvalidEmailRoleAccessPolicyException, CodeDeliveryFailureException, LimitExceededException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Generates a user attribute verification code for the specified attribute name. Sends a message to a user with a code that they must return in a VerifyUserAttribute request.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
This is a convenience which creates an instance of the GetUserAttributeVerificationCodeRequest.Builder
avoiding the need to create one manually via GetUserAttributeVerificationCodeRequest.builder()
getUserAttributeVerificationCodeRequest - A Consumer that will call methods on GetUserAttributeVerificationCodeRequest.Builder to
create a request. Represents the request to get user attribute verification.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't authorized.UnexpectedLambdaException - This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
Lambda service.InvalidLambdaResponseException - This exception is thrown when Amazon Cognito encounters an invalid Lambda response.InvalidSmsRoleAccessPolicyException - This exception is returned when the role provided for SMS configuration doesn't have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is not valid for the role provided for SMS
configuration. This can happen if you don't 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 isn't allowed to use your email identity. HTTP status code:
400.CodeDeliveryFailureException - This exception is thrown when a verification code fails to deliver successfully.LimitExceededException - This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user isn't found.UserNotConfirmedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault GetUserPoolMfaConfigResponse getUserPoolMfaConfig(GetUserPoolMfaConfigRequest getUserPoolMfaConfigRequest) throws InvalidParameterException, TooManyRequestsException, ResourceNotFoundException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Gets the user pool multi-factor authentication (MFA) configuration.
getUserPoolMfaConfigRequest - 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.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault GetUserPoolMfaConfigResponse getUserPoolMfaConfig(Consumer<GetUserPoolMfaConfigRequest.Builder> getUserPoolMfaConfigRequest) throws InvalidParameterException, TooManyRequestsException, ResourceNotFoundException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Gets the user pool multi-factor authentication (MFA) configuration.
This is a convenience which creates an instance of the GetUserPoolMfaConfigRequest.Builder avoiding the
need to create one manually via GetUserPoolMfaConfigRequest.builder()
getUserPoolMfaConfigRequest - A Consumer that will call methods on GetUserPoolMfaConfigRequest.Builder to create a
request.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.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault GlobalSignOutResponse globalSignOut(GlobalSignOutRequest globalSignOutRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, PasswordResetRequiredException, UserNotConfirmedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Signs out users from all devices. It also invalidates all refresh tokens that Amazon Cognito has issued to a user. The user's current access and ID tokens remain valid until their expiry. By default, access and ID tokens expire one hour after Amazon Cognito issues them. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the cookie validity period of 1 hour.
globalSignOutRequest - Represents the request to sign out all devices.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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.UserNotConfirmedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault GlobalSignOutResponse globalSignOut(Consumer<GlobalSignOutRequest.Builder> globalSignOutRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, PasswordResetRequiredException, UserNotConfirmedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Signs out users from all devices. It also invalidates all refresh tokens that Amazon Cognito has issued to a user. The user's current access and ID tokens remain valid until their expiry. By default, access and ID tokens expire one hour after Amazon Cognito issues them. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the cookie validity period of 1 hour.
This is a convenience which creates an instance of the GlobalSignOutRequest.Builder avoiding the need to
create one manually via GlobalSignOutRequest.builder()
globalSignOutRequest - A Consumer that will call methods on GlobalSignOutRequest.Builder to create a request.
Represents the request to sign out all devices.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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.UserNotConfirmedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault InitiateAuthResponse initiateAuth(InitiateAuthRequest initiateAuthRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, UnexpectedLambdaException, InvalidUserPoolConfigurationException, UserLambdaValidationException, InvalidLambdaResponseException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Initiates sign-in for a user in the Amazon Cognito user directory. You can't sign in a user with a federated IdP
with InitiateAuth. For more information, see
Adding user pool sign-in through a third party.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
initiateAuthRequest - Initiates the authentication request.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't authorized.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.UnexpectedLambdaException - This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.InvalidUserPoolConfigurationException - This exception is thrown when the user pool configuration is not valid.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
Lambda service.InvalidLambdaResponseException - This exception is thrown when Amazon Cognito encounters an invalid Lambda response.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user isn't found.UserNotConfirmedException - This exception is thrown when a user isn't confirmed successfully.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.InvalidSmsRoleAccessPolicyException - This exception is returned when the role provided for SMS configuration doesn't have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is not valid for the role provided for SMS
configuration. This can happen if you don't 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.AwsServiceExceptiondefault InitiateAuthResponse initiateAuth(Consumer<InitiateAuthRequest.Builder> initiateAuthRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, UnexpectedLambdaException, InvalidUserPoolConfigurationException, UserLambdaValidationException, InvalidLambdaResponseException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Initiates sign-in for a user in the Amazon Cognito user directory. You can't sign in a user with a federated IdP
with InitiateAuth. For more information, see
Adding user pool sign-in through a third party.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
This is a convenience which creates an instance of the InitiateAuthRequest.Builder avoiding the need to
create one manually via InitiateAuthRequest.builder()
initiateAuthRequest - A Consumer that will call methods on InitiateAuthRequest.Builder to create a request.
Initiates the authentication request.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't authorized.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.UnexpectedLambdaException - This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.InvalidUserPoolConfigurationException - This exception is thrown when the user pool configuration is not valid.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
Lambda service.InvalidLambdaResponseException - This exception is thrown when Amazon Cognito encounters an invalid Lambda response.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user isn't found.UserNotConfirmedException - This exception is thrown when a user isn't confirmed successfully.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.InvalidSmsRoleAccessPolicyException - This exception is returned when the role provided for SMS configuration doesn't have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is not valid for the role provided for SMS
configuration. This can happen if you don't 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.AwsServiceExceptiondefault ListDevicesResponse listDevices(ListDevicesRequest listDevicesRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, InvalidUserPoolConfigurationException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the sign-in devices that Amazon Cognito has registered to the current user.
listDevicesRequest - Represents the request to list the devices.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't authorized.InvalidUserPoolConfigurationException - This exception is thrown when the user pool configuration is not valid.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 isn't found.UserNotConfirmedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault ListDevicesResponse listDevices(Consumer<ListDevicesRequest.Builder> listDevicesRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, InvalidUserPoolConfigurationException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the sign-in devices that Amazon Cognito has registered to the current user.
This is a convenience which creates an instance of the ListDevicesRequest.Builder avoiding the need to
create one manually via ListDevicesRequest.builder()
listDevicesRequest - A Consumer that will call methods on ListDevicesRequest.Builder to create a request.
Represents the request to list the devices.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't authorized.InvalidUserPoolConfigurationException - This exception is thrown when the user pool configuration is not valid.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 isn't found.UserNotConfirmedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault ListGroupsResponse listGroups(ListGroupsRequest listGroupsRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the groups associated with a user pool.
Calling this action requires developer credentials.
listGroupsRequest - InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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.AwsServiceExceptiondefault ListGroupsResponse listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the groups associated with a user pool.
Calling this action requires developer credentials.
This is a convenience which creates an instance of the ListGroupsRequest.Builder avoiding the need to
create one manually via ListGroupsRequest.builder()
listGroupsRequest - A Consumer that will call methods on ListGroupsRequest.Builder to create a request.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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.AwsServiceExceptiondefault ListGroupsIterable listGroupsPaginator(ListGroupsRequest listGroupsRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the groups associated with a user pool.
Calling this action requires developer credentials.
This is a variant of
listGroups(software.amazon.awssdk.services.cognitoidentityprovider.model.ListGroupsRequest) operation.
The return type is a custom 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.ListGroupsIterable responses = client.listGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListGroupsIterable responses = client
.listGroupsPaginator(request);
for (software.amazon.awssdk.services.cognitoidentityprovider.model.ListGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListGroupsIterable responses = client.listGroupsPaginator(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
listGroups(software.amazon.awssdk.services.cognitoidentityprovider.model.ListGroupsRequest)
operation.
listGroupsRequest - InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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.AwsServiceExceptiondefault ListGroupsIterable listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the groups associated with a user pool.
Calling this action requires developer credentials.
This is a variant of
listGroups(software.amazon.awssdk.services.cognitoidentityprovider.model.ListGroupsRequest) operation.
The return type is a custom 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.ListGroupsIterable responses = client.listGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListGroupsIterable responses = client
.listGroupsPaginator(request);
for (software.amazon.awssdk.services.cognitoidentityprovider.model.ListGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListGroupsIterable responses = client.listGroupsPaginator(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
listGroups(software.amazon.awssdk.services.cognitoidentityprovider.model.ListGroupsRequest)
operation.
This is a convenience which creates an instance of the ListGroupsRequest.Builder avoiding the need to
create one manually via ListGroupsRequest.builder()
listGroupsRequest - A Consumer that will call methods on ListGroupsRequest.Builder to create a request.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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.AwsServiceExceptiondefault ListIdentityProvidersResponse listIdentityProviders(ListIdentityProvidersRequest listIdentityProvidersRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists information about all IdPs for a user pool.
listIdentityProvidersRequest - InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault ListIdentityProvidersResponse listIdentityProviders(Consumer<ListIdentityProvidersRequest.Builder> listIdentityProvidersRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists information about all IdPs for a user pool.
This is a convenience which creates an instance of the ListIdentityProvidersRequest.Builder avoiding the
need to create one manually via ListIdentityProvidersRequest.builder()
listIdentityProvidersRequest - A Consumer that will call methods on ListIdentityProvidersRequest.Builder to create a
request.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault ListIdentityProvidersIterable listIdentityProvidersPaginator(ListIdentityProvidersRequest listIdentityProvidersRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists information about all IdPs for a user pool.
This is a variant of
listIdentityProviders(software.amazon.awssdk.services.cognitoidentityprovider.model.ListIdentityProvidersRequest)
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.ListIdentityProvidersIterable responses = client.listIdentityProvidersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListIdentityProvidersIterable responses = client
.listIdentityProvidersPaginator(request);
for (software.amazon.awssdk.services.cognitoidentityprovider.model.ListIdentityProvidersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListIdentityProvidersIterable responses = client.listIdentityProvidersPaginator(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
listIdentityProviders(software.amazon.awssdk.services.cognitoidentityprovider.model.ListIdentityProvidersRequest)
operation.
listIdentityProvidersRequest - InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault ListIdentityProvidersIterable listIdentityProvidersPaginator(Consumer<ListIdentityProvidersRequest.Builder> listIdentityProvidersRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists information about all IdPs for a user pool.
This is a variant of
listIdentityProviders(software.amazon.awssdk.services.cognitoidentityprovider.model.ListIdentityProvidersRequest)
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.ListIdentityProvidersIterable responses = client.listIdentityProvidersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListIdentityProvidersIterable responses = client
.listIdentityProvidersPaginator(request);
for (software.amazon.awssdk.services.cognitoidentityprovider.model.ListIdentityProvidersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListIdentityProvidersIterable responses = client.listIdentityProvidersPaginator(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
listIdentityProviders(software.amazon.awssdk.services.cognitoidentityprovider.model.ListIdentityProvidersRequest)
operation.
This is a convenience which creates an instance of the ListIdentityProvidersRequest.Builder avoiding the
need to create one manually via ListIdentityProvidersRequest.builder()
listIdentityProvidersRequest - A Consumer that will call methods on ListIdentityProvidersRequest.Builder to create a
request.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault ListResourceServersResponse listResourceServers(ListResourceServersRequest listResourceServersRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the resource servers for a user pool.
listResourceServersRequest - InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault ListResourceServersResponse listResourceServers(Consumer<ListResourceServersRequest.Builder> listResourceServersRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the resource servers for a user pool.
This is a convenience which creates an instance of the ListResourceServersRequest.Builder avoiding the
need to create one manually via ListResourceServersRequest.builder()
listResourceServersRequest - A Consumer that will call methods on ListResourceServersRequest.Builder to create a
request.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault ListResourceServersIterable listResourceServersPaginator(ListResourceServersRequest listResourceServersRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the resource servers for a user pool.
This is a variant of
listResourceServers(software.amazon.awssdk.services.cognitoidentityprovider.model.ListResourceServersRequest)
operation. The return type is a custom 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.ListResourceServersIterable responses = client.listResourceServersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListResourceServersIterable responses = client
.listResourceServersPaginator(request);
for (software.amazon.awssdk.services.cognitoidentityprovider.model.ListResourceServersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListResourceServersIterable responses = client.listResourceServersPaginator(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
listResourceServers(software.amazon.awssdk.services.cognitoidentityprovider.model.ListResourceServersRequest)
operation.
listResourceServersRequest - InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault ListResourceServersIterable listResourceServersPaginator(Consumer<ListResourceServersRequest.Builder> listResourceServersRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the resource servers for a user pool.
This is a variant of
listResourceServers(software.amazon.awssdk.services.cognitoidentityprovider.model.ListResourceServersRequest)
operation. The return type is a custom 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.ListResourceServersIterable responses = client.listResourceServersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListResourceServersIterable responses = client
.listResourceServersPaginator(request);
for (software.amazon.awssdk.services.cognitoidentityprovider.model.ListResourceServersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListResourceServersIterable responses = client.listResourceServersPaginator(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
listResourceServers(software.amazon.awssdk.services.cognitoidentityprovider.model.ListResourceServersRequest)
operation.
This is a convenience which creates an instance of the ListResourceServersRequest.Builder avoiding the
need to create one manually via ListResourceServersRequest.builder()
listResourceServersRequest - A Consumer that will call methods on ListResourceServersRequest.Builder to create a
request.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InvalidParameterException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the tags that are assigned to an Amazon Cognito user pool.
A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
You can use this action up to 10 times per second, per account.
listTagsForResourceRequest - ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't authorized.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.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.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InvalidParameterException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the tags that are assigned to an Amazon Cognito user pool.
A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
You can use this action up to 10 times per second, per account.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't authorized.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.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.AwsServiceExceptiondefault ListUserImportJobsResponse listUserImportJobs(ListUserImportJobsRequest listUserImportJobsRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the user import jobs.
listUserImportJobsRequest - Represents the request to list the user import jobs.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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.AwsServiceExceptiondefault ListUserImportJobsResponse listUserImportJobs(Consumer<ListUserImportJobsRequest.Builder> listUserImportJobsRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the user import jobs.
This is a convenience which creates an instance of the ListUserImportJobsRequest.Builder avoiding the
need to create one manually via ListUserImportJobsRequest.builder()
listUserImportJobsRequest - A Consumer that will call methods on ListUserImportJobsRequest.Builder to create a
request. Represents the request to list the user import jobs.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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.AwsServiceExceptiondefault ListUserPoolClientsResponse listUserPoolClients(ListUserPoolClientsRequest listUserPoolClientsRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the clients that have been created for the specified user pool.
listUserPoolClientsRequest - Represents the request to list the user pool clients.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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.AwsServiceExceptiondefault ListUserPoolClientsResponse listUserPoolClients(Consumer<ListUserPoolClientsRequest.Builder> listUserPoolClientsRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the clients that have been created for the specified user pool.
This is a convenience which creates an instance of the ListUserPoolClientsRequest.Builder avoiding the
need to create one manually via ListUserPoolClientsRequest.builder()
listUserPoolClientsRequest - A Consumer that will call methods on ListUserPoolClientsRequest.Builder to create a
request. Represents the request to list the user pool clients.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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.AwsServiceExceptiondefault ListUserPoolClientsIterable listUserPoolClientsPaginator(ListUserPoolClientsRequest listUserPoolClientsRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the clients that have been created for the specified user pool.
This is a variant of
listUserPoolClients(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUserPoolClientsRequest)
operation. The return type is a custom 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.ListUserPoolClientsIterable responses = client.listUserPoolClientsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUserPoolClientsIterable responses = client
.listUserPoolClientsPaginator(request);
for (software.amazon.awssdk.services.cognitoidentityprovider.model.ListUserPoolClientsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUserPoolClientsIterable responses = client.listUserPoolClientsPaginator(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
listUserPoolClients(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUserPoolClientsRequest)
operation.
listUserPoolClientsRequest - Represents the request to list the user pool clients.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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.AwsServiceExceptiondefault ListUserPoolClientsIterable listUserPoolClientsPaginator(Consumer<ListUserPoolClientsRequest.Builder> listUserPoolClientsRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the clients that have been created for the specified user pool.
This is a variant of
listUserPoolClients(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUserPoolClientsRequest)
operation. The return type is a custom 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.ListUserPoolClientsIterable responses = client.listUserPoolClientsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUserPoolClientsIterable responses = client
.listUserPoolClientsPaginator(request);
for (software.amazon.awssdk.services.cognitoidentityprovider.model.ListUserPoolClientsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUserPoolClientsIterable responses = client.listUserPoolClientsPaginator(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
listUserPoolClients(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUserPoolClientsRequest)
operation.
This is a convenience which creates an instance of the ListUserPoolClientsRequest.Builder avoiding the
need to create one manually via ListUserPoolClientsRequest.builder()
listUserPoolClientsRequest - A Consumer that will call methods on ListUserPoolClientsRequest.Builder to create a
request. Represents the request to list the user pool clients.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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.AwsServiceExceptiondefault ListUserPoolsResponse listUserPools(ListUserPoolsRequest listUserPoolsRequest) throws InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the user pools associated with an Amazon Web Services account.
listUserPoolsRequest - Represents the request to list user pools.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 isn't 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.AwsServiceExceptiondefault ListUserPoolsResponse listUserPools(Consumer<ListUserPoolsRequest.Builder> listUserPoolsRequest) throws InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the user pools associated with an Amazon Web Services account.
This is a convenience which creates an instance of the ListUserPoolsRequest.Builder avoiding the need to
create one manually via ListUserPoolsRequest.builder()
listUserPoolsRequest - A Consumer that will call methods on ListUserPoolsRequest.Builder to create a request.
Represents the request to list user pools.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 isn't 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.AwsServiceExceptiondefault ListUserPoolsIterable listUserPoolsPaginator(ListUserPoolsRequest listUserPoolsRequest) throws InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the user pools associated with an Amazon Web Services account.
This is a variant of
listUserPools(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUserPoolsRequest)
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.ListUserPoolsIterable responses = client.listUserPoolsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUserPoolsIterable responses = client
.listUserPoolsPaginator(request);
for (software.amazon.awssdk.services.cognitoidentityprovider.model.ListUserPoolsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUserPoolsIterable responses = client.listUserPoolsPaginator(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
listUserPools(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUserPoolsRequest)
operation.
listUserPoolsRequest - Represents the request to list user pools.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 isn't 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.AwsServiceExceptiondefault ListUserPoolsIterable listUserPoolsPaginator(Consumer<ListUserPoolsRequest.Builder> listUserPoolsRequest) throws InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the user pools associated with an Amazon Web Services account.
This is a variant of
listUserPools(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUserPoolsRequest)
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.ListUserPoolsIterable responses = client.listUserPoolsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUserPoolsIterable responses = client
.listUserPoolsPaginator(request);
for (software.amazon.awssdk.services.cognitoidentityprovider.model.ListUserPoolsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUserPoolsIterable responses = client.listUserPoolsPaginator(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
listUserPools(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUserPoolsRequest)
operation.
This is a convenience which creates an instance of the ListUserPoolsRequest.Builder avoiding the need to
create one manually via ListUserPoolsRequest.builder()
listUserPoolsRequest - A Consumer that will call methods on ListUserPoolsRequest.Builder to create a request.
Represents the request to list user pools.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 isn't 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.AwsServiceExceptiondefault ListUsersResponse listUsers(ListUsersRequest listUsersRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the users in the Amazon Cognito user pool.
listUsersRequest - Represents the request to list users.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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.AwsServiceExceptiondefault ListUsersResponse listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the users in the Amazon Cognito user pool.
This is a convenience which creates an instance of the ListUsersRequest.Builder avoiding the need to
create one manually via ListUsersRequest.builder()
listUsersRequest - A Consumer that will call methods on ListUsersRequest.Builder to create a request.
Represents the request to list users.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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.AwsServiceExceptiondefault ListUsersIterable listUsersPaginator(ListUsersRequest listUsersRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the users in the Amazon Cognito user pool.
This is a variant of
listUsers(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUsersRequest) operation. The
return type is a custom 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.ListUsersIterable responses = client.listUsersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUsersIterable responses = client
.listUsersPaginator(request);
for (software.amazon.awssdk.services.cognitoidentityprovider.model.ListUsersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUsersIterable responses = client.listUsersPaginator(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
listUsers(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUsersRequest) operation.
listUsersRequest - Represents the request to list users.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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.AwsServiceExceptiondefault ListUsersIterable listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the users in the Amazon Cognito user pool.
This is a variant of
listUsers(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUsersRequest) operation. The
return type is a custom 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.ListUsersIterable responses = client.listUsersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUsersIterable responses = client
.listUsersPaginator(request);
for (software.amazon.awssdk.services.cognitoidentityprovider.model.ListUsersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUsersIterable responses = client.listUsersPaginator(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
listUsers(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUsersRequest) operation.
This is a convenience which creates an instance of the ListUsersRequest.Builder avoiding the need to
create one manually via ListUsersRequest.builder()
listUsersRequest - A Consumer that will call methods on ListUsersRequest.Builder to create a request.
Represents the request to list users.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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.AwsServiceExceptiondefault ListUsersInGroupResponse listUsersInGroup(ListUsersInGroupRequest listUsersInGroupRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the users in the specified group.
Calling this action requires developer credentials.
listUsersInGroupRequest - InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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.AwsServiceExceptiondefault ListUsersInGroupResponse listUsersInGroup(Consumer<ListUsersInGroupRequest.Builder> listUsersInGroupRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the users in the specified group.
Calling this action requires developer credentials.
This is a convenience which creates an instance of the ListUsersInGroupRequest.Builder avoiding the need
to create one manually via ListUsersInGroupRequest.builder()
listUsersInGroupRequest - A Consumer that will call methods on ListUsersInGroupRequest.Builder to create a request.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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.AwsServiceExceptiondefault ListUsersInGroupIterable listUsersInGroupPaginator(ListUsersInGroupRequest listUsersInGroupRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the users in the specified group.
Calling this action requires developer credentials.
This is a variant of
listUsersInGroup(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUsersInGroupRequest)
operation. The return type is a custom 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.ListUsersInGroupIterable responses = client.listUsersInGroupPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUsersInGroupIterable responses = client
.listUsersInGroupPaginator(request);
for (software.amazon.awssdk.services.cognitoidentityprovider.model.ListUsersInGroupResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUsersInGroupIterable responses = client.listUsersInGroupPaginator(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
listUsersInGroup(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUsersInGroupRequest)
operation.
listUsersInGroupRequest - InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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.AwsServiceExceptiondefault ListUsersInGroupIterable listUsersInGroupPaginator(Consumer<ListUsersInGroupRequest.Builder> listUsersInGroupRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the users in the specified group.
Calling this action requires developer credentials.
This is a variant of
listUsersInGroup(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUsersInGroupRequest)
operation. The return type is a custom 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.ListUsersInGroupIterable responses = client.listUsersInGroupPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUsersInGroupIterable responses = client
.listUsersInGroupPaginator(request);
for (software.amazon.awssdk.services.cognitoidentityprovider.model.ListUsersInGroupResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUsersInGroupIterable responses = client.listUsersInGroupPaginator(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
listUsersInGroup(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUsersInGroupRequest)
operation.
This is a convenience which creates an instance of the ListUsersInGroupRequest.Builder avoiding the need
to create one manually via ListUsersInGroupRequest.builder()
listUsersInGroupRequest - A Consumer that will call methods on ListUsersInGroupRequest.Builder to create a request.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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.AwsServiceExceptiondefault ResendConfirmationCodeResponse resendConfirmationCode(ResendConfirmationCodeRequest resendConfirmationCodeRequest) throws ResourceNotFoundException, InvalidParameterException, UnexpectedLambdaException, UserLambdaValidationException, NotAuthorizedException, InvalidLambdaResponseException, TooManyRequestsException, LimitExceededException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InvalidEmailRoleAccessPolicyException, CodeDeliveryFailureException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
resendConfirmationCodeRequest - Represents the request to resend the confirmation code.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnexpectedLambdaException - This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
Lambda service.NotAuthorizedException - This exception is thrown when a user isn't authorized.InvalidLambdaResponseException - This exception is thrown when Amazon Cognito encounters an invalid 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 Amazon Web Services resource.InvalidSmsRoleAccessPolicyException - This exception is returned when the role provided for SMS configuration doesn't have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is not valid for the role provided for SMS
configuration. This can happen if you don't 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 isn't allowed to use your email identity. HTTP status code:
400.CodeDeliveryFailureException - This exception is thrown when a verification code fails to deliver successfully.UserNotFoundException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault ResendConfirmationCodeResponse resendConfirmationCode(Consumer<ResendConfirmationCodeRequest.Builder> resendConfirmationCodeRequest) throws ResourceNotFoundException, InvalidParameterException, UnexpectedLambdaException, UserLambdaValidationException, NotAuthorizedException, InvalidLambdaResponseException, TooManyRequestsException, LimitExceededException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InvalidEmailRoleAccessPolicyException, CodeDeliveryFailureException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
This is a convenience which creates an instance of the ResendConfirmationCodeRequest.Builder avoiding the
need to create one manually via ResendConfirmationCodeRequest.builder()
resendConfirmationCodeRequest - A Consumer that will call methods on ResendConfirmationCodeRequest.Builder to create a
request. Represents the request to resend the confirmation code.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnexpectedLambdaException - This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
Lambda service.NotAuthorizedException - This exception is thrown when a user isn't authorized.InvalidLambdaResponseException - This exception is thrown when Amazon Cognito encounters an invalid 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 Amazon Web Services resource.InvalidSmsRoleAccessPolicyException - This exception is returned when the role provided for SMS configuration doesn't have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is not valid for the role provided for SMS
configuration. This can happen if you don't 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 isn't allowed to use your email identity. HTTP status code:
400.CodeDeliveryFailureException - This exception is thrown when a verification code fails to deliver successfully.UserNotFoundException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault RespondToAuthChallengeResponse respondToAuthChallenge(RespondToAuthChallengeRequest respondToAuthChallengeRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, CodeMismatchException, ExpiredCodeException, UnexpectedLambdaException, UserLambdaValidationException, InvalidPasswordException, InvalidLambdaResponseException, TooManyRequestsException, InvalidUserPoolConfigurationException, MfaMethodNotFoundException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, AliasExistsException, InternalErrorException, SoftwareTokenMfaNotFoundException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Responds to the authentication challenge.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
respondToAuthChallengeRequest - The request to respond to an authentication challenge.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't authorized.CodeMismatchException - This exception is thrown if the provided code doesn't match what the server was expecting.ExpiredCodeException - This exception is thrown if a code has expired.UnexpectedLambdaException - This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
Lambda service.InvalidPasswordException - This exception is thrown when Amazon Cognito encounters an invalid password.InvalidLambdaResponseException - This exception is thrown when Amazon Cognito encounters an invalid 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 not valid.MfaMethodNotFoundException - This exception is thrown when Amazon Cognito can't find a multi-factor authentication (MFA) method.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user isn't found.UserNotConfirmedException - This exception is thrown when a user isn't confirmed successfully.InvalidSmsRoleAccessPolicyException - This exception is returned when the role provided for SMS configuration doesn't have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is not valid for the role provided for SMS
configuration. This can happen if you don't 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 address or phone number
that has already been supplied as an alias for a different user profile. This exception indicates that an
account with this email address or phone already exists in a user pool that you've configured to use
email address or phone number as a sign-in alias.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.SoftwareTokenMfaNotFoundException - This exception is thrown when the software token time-based one-time password (TOTP) multi-factor
authentication (MFA) isn't activated 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.AwsServiceExceptiondefault RespondToAuthChallengeResponse respondToAuthChallenge(Consumer<RespondToAuthChallengeRequest.Builder> respondToAuthChallengeRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, CodeMismatchException, ExpiredCodeException, UnexpectedLambdaException, UserLambdaValidationException, InvalidPasswordException, InvalidLambdaResponseException, TooManyRequestsException, InvalidUserPoolConfigurationException, MfaMethodNotFoundException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, AliasExistsException, InternalErrorException, SoftwareTokenMfaNotFoundException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Responds to the authentication challenge.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
This is a convenience which creates an instance of the RespondToAuthChallengeRequest.Builder avoiding the
need to create one manually via RespondToAuthChallengeRequest.builder()
respondToAuthChallengeRequest - A Consumer that will call methods on RespondToAuthChallengeRequest.Builder to create a
request. The request to respond to an authentication challenge.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't authorized.CodeMismatchException - This exception is thrown if the provided code doesn't match what the server was expecting.ExpiredCodeException - This exception is thrown if a code has expired.UnexpectedLambdaException - This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
Lambda service.InvalidPasswordException - This exception is thrown when Amazon Cognito encounters an invalid password.InvalidLambdaResponseException - This exception is thrown when Amazon Cognito encounters an invalid 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 not valid.MfaMethodNotFoundException - This exception is thrown when Amazon Cognito can't find a multi-factor authentication (MFA) method.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user isn't found.UserNotConfirmedException - This exception is thrown when a user isn't confirmed successfully.InvalidSmsRoleAccessPolicyException - This exception is returned when the role provided for SMS configuration doesn't have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is not valid for the role provided for SMS
configuration. This can happen if you don't 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 address or phone number
that has already been supplied as an alias for a different user profile. This exception indicates that an
account with this email address or phone already exists in a user pool that you've configured to use
email address or phone number as a sign-in alias.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.SoftwareTokenMfaNotFoundException - This exception is thrown when the software token time-based one-time password (TOTP) multi-factor
authentication (MFA) isn't activated 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.AwsServiceExceptiondefault RevokeTokenResponse revokeToken(RevokeTokenRequest revokeTokenRequest) throws TooManyRequestsException, InternalErrorException, UnauthorizedException, InvalidParameterException, UnsupportedOperationException, UnsupportedTokenTypeException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Revokes all of the access tokens generated by the specified refresh token. After the token is revoked, you can't use the revoked token to access Amazon Cognito authenticated APIs.
revokeTokenRequest - 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.UnauthorizedException - Exception that is thrown when the request isn't authorized. This can happen due to an invalid access
token in the request.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnsupportedOperationException - Exception that is thrown when you attempt to perform an operation that isn't enabled for the user pool
client.UnsupportedTokenTypeException - Exception that is thrown when an unsupported token is passed to an operation.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.UnsupportedOperationExceptionAwsServiceExceptiondefault RevokeTokenResponse revokeToken(Consumer<RevokeTokenRequest.Builder> revokeTokenRequest) throws TooManyRequestsException, InternalErrorException, UnauthorizedException, InvalidParameterException, UnsupportedOperationException, UnsupportedTokenTypeException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Revokes all of the access tokens generated by the specified refresh token. After the token is revoked, you can't use the revoked token to access Amazon Cognito authenticated APIs.
This is a convenience which creates an instance of the RevokeTokenRequest.Builder avoiding the need to
create one manually via RevokeTokenRequest.builder()
revokeTokenRequest - A Consumer that will call methods on RevokeTokenRequest.Builder to create a request.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.UnauthorizedException - Exception that is thrown when the request isn't authorized. This can happen due to an invalid access
token in the request.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnsupportedOperationException - Exception that is thrown when you attempt to perform an operation that isn't enabled for the user pool
client.UnsupportedTokenTypeException - Exception that is thrown when an unsupported token is passed to an operation.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.UnsupportedOperationExceptionAwsServiceExceptiondefault SetRiskConfigurationResponse setRiskConfiguration(SetRiskConfigurationRequest setRiskConfigurationRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserPoolAddOnNotEnabledException, CodeDeliveryFailureException, InvalidEmailRoleAccessPolicyException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Configures actions on detected risks. To delete the risk configuration for UserPoolId or
ClientId, pass null values for all four configuration types.
To activate Amazon Cognito advanced security features, update the user pool to include the
UserPoolAddOns keyAdvancedSecurityMode.
setRiskConfigurationRequest - ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't authorized.UserPoolAddOnNotEnabledException - This exception is thrown when user pool add-ons aren't enabled.CodeDeliveryFailureException - This exception is thrown when a verification code fails to deliver successfully.InvalidEmailRoleAccessPolicyException - This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP status code:
400.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.AwsServiceExceptiondefault SetRiskConfigurationResponse setRiskConfiguration(Consumer<SetRiskConfigurationRequest.Builder> setRiskConfigurationRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserPoolAddOnNotEnabledException, CodeDeliveryFailureException, InvalidEmailRoleAccessPolicyException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Configures actions on detected risks. To delete the risk configuration for UserPoolId or
ClientId, pass null values for all four configuration types.
To activate Amazon Cognito advanced security features, update the user pool to include the
UserPoolAddOns keyAdvancedSecurityMode.
This is a convenience which creates an instance of the SetRiskConfigurationRequest.Builder avoiding the
need to create one manually via SetRiskConfigurationRequest.builder()
setRiskConfigurationRequest - A Consumer that will call methods on SetRiskConfigurationRequest.Builder to create a
request.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't authorized.UserPoolAddOnNotEnabledException - This exception is thrown when user pool add-ons aren't enabled.CodeDeliveryFailureException - This exception is thrown when a verification code fails to deliver successfully.InvalidEmailRoleAccessPolicyException - This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP status code:
400.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.AwsServiceExceptiondefault SetUiCustomizationResponse setUICustomization(SetUiCustomizationRequest setUiCustomizationRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Sets the user interface (UI) customization information for a user pool's built-in app UI.
You can specify app UI customization settings for a single client (with a specific clientId) or for
all clients (by setting the clientId to ALL). If you specify ALL, the
default configuration is used for every client that has no previously set UI customization. If you specify UI
customization settings for a particular client, it will no longer return to the ALL configuration.
To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app's pages, and the service will throw an error.
setUiCustomizationRequest - InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault SetUiCustomizationResponse setUICustomization(Consumer<SetUiCustomizationRequest.Builder> setUiCustomizationRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Sets the user interface (UI) customization information for a user pool's built-in app UI.
You can specify app UI customization settings for a single client (with a specific clientId) or for
all clients (by setting the clientId to ALL). If you specify ALL, the
default configuration is used for every client that has no previously set UI customization. If you specify UI
customization settings for a particular client, it will no longer return to the ALL configuration.
To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app's pages, and the service will throw an error.
This is a convenience which creates an instance of the SetUiCustomizationRequest.Builder avoiding the
need to create one manually via SetUiCustomizationRequest.builder()
setUiCustomizationRequest - A Consumer that will call methods on SetUICustomizationRequest.Builder to create a
request.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault SetUserMfaPreferenceResponse setUserMFAPreference(SetUserMfaPreferenceRequest setUserMfaPreferenceRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are activated 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 activated. If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts unless device tracking is turned on and the device has been trusted. If you want MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool.
setUserMfaPreferenceRequest - ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't authorized.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user isn't found.UserNotConfirmedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault SetUserMfaPreferenceResponse setUserMFAPreference(Consumer<SetUserMfaPreferenceRequest.Builder> setUserMfaPreferenceRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are activated 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 activated. If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts unless device tracking is turned on and the device has been trusted. If you want MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool.
This is a convenience which creates an instance of the SetUserMfaPreferenceRequest.Builder avoiding the
need to create one manually via SetUserMfaPreferenceRequest.builder()
setUserMfaPreferenceRequest - A Consumer that will call methods on SetUserMFAPreferenceRequest.Builder to create a
request.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't authorized.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user isn't found.UserNotConfirmedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault SetUserPoolMfaConfigResponse setUserPoolMfaConfig(SetUserPoolMfaConfigRequest setUserPoolMfaConfigRequest) throws InvalidParameterException, TooManyRequestsException, ResourceNotFoundException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Sets the user pool multi-factor authentication (MFA) configuration.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
setUserPoolMfaConfigRequest - 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.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.InvalidSmsRoleAccessPolicyException - This exception is returned when the role provided for SMS configuration doesn't have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is not valid for the role provided for SMS
configuration. This can happen if you don't 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.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault SetUserPoolMfaConfigResponse setUserPoolMfaConfig(Consumer<SetUserPoolMfaConfigRequest.Builder> setUserPoolMfaConfigRequest) throws InvalidParameterException, TooManyRequestsException, ResourceNotFoundException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Sets the user pool multi-factor authentication (MFA) configuration.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
This is a convenience which creates an instance of the SetUserPoolMfaConfigRequest.Builder avoiding the
need to create one manually via SetUserPoolMfaConfigRequest.builder()
setUserPoolMfaConfigRequest - A Consumer that will call methods on SetUserPoolMfaConfigRequest.Builder to create a
request.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.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.InvalidSmsRoleAccessPolicyException - This exception is returned when the role provided for SMS configuration doesn't have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is not valid for the role provided for SMS
configuration. This can happen if you don't 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.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault SetUserSettingsResponse setUserSettings(SetUserSettingsRequest setUserSettingsRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, 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 time-based one-time password (TOTP) software token MFA. To configure either type of MFA, use SetUserMFAPreference instead.
setUserSettingsRequest - Represents the request to set user settings.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't authorized.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user isn't found.UserNotConfirmedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault SetUserSettingsResponse setUserSettings(Consumer<SetUserSettingsRequest.Builder> setUserSettingsRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, 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 time-based one-time password (TOTP) software token MFA. To configure either type of MFA, use SetUserMFAPreference instead.
This is a convenience which creates an instance of the SetUserSettingsRequest.Builder avoiding the need
to create one manually via SetUserSettingsRequest.builder()
setUserSettingsRequest - A Consumer that will call methods on SetUserSettingsRequest.Builder to create a request.
Represents the request to set user settings.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't authorized.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user isn't found.UserNotConfirmedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault SignUpResponse signUp(SignUpRequest signUpRequest) throws ResourceNotFoundException, InvalidParameterException, UnexpectedLambdaException, UserLambdaValidationException, NotAuthorizedException, InvalidPasswordException, InvalidLambdaResponseException, UsernameExistsException, TooManyRequestsException, InternalErrorException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InvalidEmailRoleAccessPolicyException, CodeDeliveryFailureException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Registers the user in the specified user pool and creates a user name, password, and user attributes.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
signUpRequest - Represents the request to register a user.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnexpectedLambdaException - This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
Lambda service.NotAuthorizedException - This exception is thrown when a user isn't authorized.InvalidPasswordException - This exception is thrown when Amazon Cognito encounters an invalid password.InvalidLambdaResponseException - This exception is thrown when Amazon Cognito encounters an invalid Lambda response.UsernameExistsException - This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.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.InvalidSmsRoleAccessPolicyException - This exception is returned when the role provided for SMS configuration doesn't have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is not valid for the role provided for SMS
configuration. This can happen if you don't 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 isn't allowed to use your email identity. HTTP status code:
400.CodeDeliveryFailureException - This exception is thrown when a verification code fails to deliver 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.AwsServiceExceptiondefault SignUpResponse signUp(Consumer<SignUpRequest.Builder> signUpRequest) throws ResourceNotFoundException, InvalidParameterException, UnexpectedLambdaException, UserLambdaValidationException, NotAuthorizedException, InvalidPasswordException, InvalidLambdaResponseException, UsernameExistsException, TooManyRequestsException, InternalErrorException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InvalidEmailRoleAccessPolicyException, CodeDeliveryFailureException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Registers the user in the specified user pool and creates a user name, password, and user attributes.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
This is a convenience which creates an instance of the SignUpRequest.Builder avoiding the need to create
one manually via SignUpRequest.builder()
signUpRequest - A Consumer that will call methods on SignUpRequest.Builder to create a request. Represents
the request to register a user.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnexpectedLambdaException - This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
Lambda service.NotAuthorizedException - This exception is thrown when a user isn't authorized.InvalidPasswordException - This exception is thrown when Amazon Cognito encounters an invalid password.InvalidLambdaResponseException - This exception is thrown when Amazon Cognito encounters an invalid Lambda response.UsernameExistsException - This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.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.InvalidSmsRoleAccessPolicyException - This exception is returned when the role provided for SMS configuration doesn't have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is not valid for the role provided for SMS
configuration. This can happen if you don't 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 isn't allowed to use your email identity. HTTP status code:
400.CodeDeliveryFailureException - This exception is thrown when a verification code fails to deliver 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.AwsServiceExceptiondefault StartUserImportJobResponse startUserImportJob(StartUserImportJobRequest startUserImportJobRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, InternalErrorException, PreconditionNotMetException, NotAuthorizedException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Starts the user import.
startUserImportJobRequest - Represents the request to start the user import job.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.PreconditionNotMetException - This exception is thrown when a precondition is not met.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault StartUserImportJobResponse startUserImportJob(Consumer<StartUserImportJobRequest.Builder> startUserImportJobRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, InternalErrorException, PreconditionNotMetException, NotAuthorizedException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Starts the user import.
This is a convenience which creates an instance of the StartUserImportJobRequest.Builder avoiding the
need to create one manually via StartUserImportJobRequest.builder()
startUserImportJobRequest - A Consumer that will call methods on StartUserImportJobRequest.Builder to create a
request. Represents the request to start the user import job.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.PreconditionNotMetException - This exception is thrown when a precondition is not met.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault StopUserImportJobResponse stopUserImportJob(StopUserImportJobRequest stopUserImportJobRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, InternalErrorException, PreconditionNotMetException, NotAuthorizedException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Stops the user import job.
stopUserImportJobRequest - Represents the request to stop the user import job.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.PreconditionNotMetException - This exception is thrown when a precondition is not met.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault StopUserImportJobResponse stopUserImportJob(Consumer<StopUserImportJobRequest.Builder> stopUserImportJobRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, InternalErrorException, PreconditionNotMetException, NotAuthorizedException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Stops the user import job.
This is a convenience which creates an instance of the StopUserImportJobRequest.Builder avoiding the need
to create one manually via StopUserImportJobRequest.builder()
stopUserImportJobRequest - A Consumer that will call methods on StopUserImportJobRequest.Builder to create a request.
Represents the request to stop the user import job.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.PreconditionNotMetException - This exception is thrown when a precondition is not met.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InvalidParameterException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
Each tag consists of a key and value, both of which you define. A key is a general category for more specific
values. For example, if you have two versions of a user pool, one for testing and another for production, you
might assign an Environment tag key to both user pools. The value of this key might be
Test for one user pool, and Production for the other.
Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your user pools. In an Identity and Access Management policy, you can constrain permissions for user pools based on specific tags or tag values.
You can use this action up to 5 times per second, per account. A user pool can have as many as 50 tags.
tagResourceRequest - ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't authorized.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.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.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InvalidParameterException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
Each tag consists of a key and value, both of which you define. A key is a general category for more specific
values. For example, if you have two versions of a user pool, one for testing and another for production, you
might assign an Environment tag key to both user pools. The value of this key might be
Test for one user pool, and Production for the other.
Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your user pools. In an Identity and Access Management policy, you can constrain permissions for user pools based on specific tags or tag values.
You can use this action up to 5 times per second, per account. A user pool can have as many as 50 tags.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't authorized.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.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.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InvalidParameterException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account.
untagResourceRequest - ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't authorized.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.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.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InvalidParameterException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't authorized.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.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.AwsServiceExceptiondefault UpdateAuthEventFeedbackResponse updateAuthEventFeedback(UpdateAuthEventFeedbackRequest updateAuthEventFeedbackRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, UserPoolAddOnNotEnabledException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Provides the feedback for an authentication event, whether it was from a valid user or not. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.
updateAuthEventFeedbackRequest - InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't found.UserPoolAddOnNotEnabledException - This exception is thrown when user pool add-ons aren't 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.AwsServiceExceptiondefault UpdateAuthEventFeedbackResponse updateAuthEventFeedback(Consumer<UpdateAuthEventFeedbackRequest.Builder> updateAuthEventFeedbackRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, UserPoolAddOnNotEnabledException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Provides the feedback for an authentication event, whether it was from a valid user or not. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.
This is a convenience which creates an instance of the UpdateAuthEventFeedbackRequest.Builder avoiding
the need to create one manually via UpdateAuthEventFeedbackRequest.builder()
updateAuthEventFeedbackRequest - A Consumer that will call methods on UpdateAuthEventFeedbackRequest.Builder to create a
request.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't authorized.UserNotFoundException - This exception is thrown when a user isn't found.UserPoolAddOnNotEnabledException - This exception is thrown when user pool add-ons aren't 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.AwsServiceExceptiondefault UpdateDeviceStatusResponse updateDeviceStatus(UpdateDeviceStatusRequest updateDeviceStatusRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, InvalidUserPoolConfigurationException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Updates the device status.
updateDeviceStatusRequest - Represents the request to update the device status.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't authorized.InvalidUserPoolConfigurationException - This exception is thrown when the user pool configuration is not valid.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 isn't found.UserNotConfirmedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault UpdateDeviceStatusResponse updateDeviceStatus(Consumer<UpdateDeviceStatusRequest.Builder> updateDeviceStatusRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, InvalidUserPoolConfigurationException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Updates the device status.
This is a convenience which creates an instance of the UpdateDeviceStatusRequest.Builder avoiding the
need to create one manually via UpdateDeviceStatusRequest.builder()
updateDeviceStatusRequest - A Consumer that will call methods on UpdateDeviceStatusRequest.Builder to create a
request. Represents the request to update the device status.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't authorized.InvalidUserPoolConfigurationException - This exception is thrown when the user pool configuration is not valid.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 isn't found.UserNotConfirmedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault UpdateGroupResponse updateGroup(UpdateGroupRequest updateGroupRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Updates the specified group with the specified attributes.
Calling this action requires developer credentials.
updateGroupRequest - ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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.AwsServiceExceptiondefault UpdateGroupResponse updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Updates the specified group with the specified attributes.
Calling this action requires developer credentials.
This is a convenience which creates an instance of the UpdateGroupRequest.Builder avoiding the need to
create one manually via UpdateGroupRequest.builder()
updateGroupRequest - A Consumer that will call methods on UpdateGroupRequest.Builder to create a request.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't 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 isn't 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.AwsServiceExceptiondefault UpdateIdentityProviderResponse updateIdentityProvider(UpdateIdentityProviderRequest updateIdentityProviderRequest) throws InvalidParameterException, UnsupportedIdentityProviderException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Updates IdP information for a user pool.
updateIdentityProviderRequest - InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnsupportedIdentityProviderException - This exception is thrown when the specified identifier isn't supported.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault UpdateIdentityProviderResponse updateIdentityProvider(Consumer<UpdateIdentityProviderRequest.Builder> updateIdentityProviderRequest) throws InvalidParameterException, UnsupportedIdentityProviderException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Updates IdP information for a user pool.
This is a convenience which creates an instance of the UpdateIdentityProviderRequest.Builder avoiding the
need to create one manually via UpdateIdentityProviderRequest.builder()
updateIdentityProviderRequest - A Consumer that will call methods on UpdateIdentityProviderRequest.Builder to create a
request.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnsupportedIdentityProviderException - This exception is thrown when the specified identifier isn't supported.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault UpdateResourceServerResponse updateResourceServer(UpdateResourceServerRequest updateResourceServerRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Updates the name and scopes of resource server. All other fields are read-only.
If you don't provide a value for an attribute, it is set to the default value.
updateResourceServerRequest - InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault UpdateResourceServerResponse updateResourceServer(Consumer<UpdateResourceServerRequest.Builder> updateResourceServerRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Updates the name and scopes of resource server. All other fields are read-only.
If you don't provide a value for an attribute, it is set to the default value.
This is a convenience which creates an instance of the UpdateResourceServerRequest.Builder avoiding the
need to create one manually via UpdateResourceServerRequest.builder()
updateResourceServerRequest - A Consumer that will call methods on UpdateResourceServerRequest.Builder to create a
request.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.NotAuthorizedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault UpdateUserAttributesResponse updateUserAttributes(UpdateUserAttributesRequest updateUserAttributesRequest) throws ResourceNotFoundException, InvalidParameterException, CodeMismatchException, ExpiredCodeException, NotAuthorizedException, UnexpectedLambdaException, UserLambdaValidationException, InvalidLambdaResponseException, TooManyRequestsException, AliasExistsException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InvalidEmailRoleAccessPolicyException, CodeDeliveryFailureException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Allows a user to update a specific attribute (one at a time).
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
updateUserAttributesRequest - Represents the request to update user attributes.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.CodeMismatchException - This exception is thrown if the provided code doesn't match what the server was expecting.ExpiredCodeException - This exception is thrown if a code has expired.NotAuthorizedException - This exception is thrown when a user isn't authorized.UnexpectedLambdaException - This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
Lambda service.InvalidLambdaResponseException - This exception is thrown when Amazon Cognito encounters an invalid Lambda response.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.AliasExistsException - This exception is thrown when a user tries to confirm the account with an email address or phone number
that has already been supplied as an alias for a different user profile. This exception indicates that an
account with this email address or phone already exists in a user pool that you've configured to use
email address or phone number as a sign-in alias.InvalidSmsRoleAccessPolicyException - This exception is returned when the role provided for SMS configuration doesn't have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is not valid for the role provided for SMS
configuration. This can happen if you don't 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 isn't allowed to use your email identity. HTTP status code:
400.CodeDeliveryFailureException - This exception is thrown when a verification code fails to deliver successfully.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user isn't found.UserNotConfirmedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault UpdateUserAttributesResponse updateUserAttributes(Consumer<UpdateUserAttributesRequest.Builder> updateUserAttributesRequest) throws ResourceNotFoundException, InvalidParameterException, CodeMismatchException, ExpiredCodeException, NotAuthorizedException, UnexpectedLambdaException, UserLambdaValidationException, InvalidLambdaResponseException, TooManyRequestsException, AliasExistsException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InvalidEmailRoleAccessPolicyException, CodeDeliveryFailureException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Allows a user to update a specific attribute (one at a time).
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
This is a convenience which creates an instance of the UpdateUserAttributesRequest.Builder avoiding the
need to create one manually via UpdateUserAttributesRequest.builder()
updateUserAttributesRequest - A Consumer that will call methods on UpdateUserAttributesRequest.Builder to create a
request. Represents the request to update user attributes.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.CodeMismatchException - This exception is thrown if the provided code doesn't match what the server was expecting.ExpiredCodeException - This exception is thrown if a code has expired.NotAuthorizedException - This exception is thrown when a user isn't authorized.UnexpectedLambdaException - This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
Lambda service.InvalidLambdaResponseException - This exception is thrown when Amazon Cognito encounters an invalid Lambda response.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.AliasExistsException - This exception is thrown when a user tries to confirm the account with an email address or phone number
that has already been supplied as an alias for a different user profile. This exception indicates that an
account with this email address or phone already exists in a user pool that you've configured to use
email address or phone number as a sign-in alias.InvalidSmsRoleAccessPolicyException - This exception is returned when the role provided for SMS configuration doesn't have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is not valid for the role provided for SMS
configuration. This can happen if you don't 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 isn't allowed to use your email identity. HTTP status code:
400.CodeDeliveryFailureException - This exception is thrown when a verification code fails to deliver successfully.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user isn't found.UserNotConfirmedException - This exception is thrown when a user isn't 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.AwsServiceExceptiondefault UpdateUserPoolResponse updateUserPool(UpdateUserPoolRequest updateUserPoolRequest) throws ResourceNotFoundException, InvalidParameterException, ConcurrentModificationException, TooManyRequestsException, NotAuthorizedException, UserImportInProgressException, InternalErrorException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, UserPoolTaggingException, InvalidEmailRoleAccessPolicyException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings using DescribeUserPool. If you don't provide a value for an attribute, it will be set to the default value.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
updateUserPoolRequest - Represents the request to update the user pool.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ConcurrentModificationException - This exception is thrown if two or more modifications are happening concurrently.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 isn't authorized.UserImportInProgressException - This exception is thrown when you're 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.InvalidSmsRoleAccessPolicyException - This exception is returned when the role provided for SMS configuration doesn't have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is not valid for the role provided for SMS
configuration. This can happen if you don't 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.UserPoolTaggingException - This exception is thrown when a user pool tag can't be set or updated.InvalidEmailRoleAccessPolicyException - This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP status code:
400.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.AwsServiceExceptiondefault UpdateUserPoolResponse updateUserPool(Consumer<UpdateUserPoolRequest.Builder> updateUserPoolRequest) throws ResourceNotFoundException, InvalidParameterException, ConcurrentModificationException, TooManyRequestsException, NotAuthorizedException, UserImportInProgressException, InternalErrorException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, UserPoolTaggingException, InvalidEmailRoleAccessPolicyException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings using DescribeUserPool. If you don't provide a value for an attribute, it will be set to the default value.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
This is a convenience which creates an instance of the UpdateUserPoolRequest.Builder avoiding the need to
create one manually via UpdateUserPoolRequest.builder()
updateUserPoolRequest - A Consumer that will call methods on UpdateUserPoolRequest.Builder to create a request.
Represents the request to update the user pool.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ConcurrentModificationException - This exception is thrown if two or more modifications are happening concurrently.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 isn't authorized.UserImportInProgressException - This exception is thrown when you're 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.InvalidSmsRoleAccessPolicyException - This exception is returned when the role provided for SMS configuration doesn't have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is not valid for the role provided for SMS
configuration. This can happen if you don't 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.UserPoolTaggingException - This exception is thrown when a user pool tag can't be set or updated.InvalidEmailRoleAccessPolicyException - This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP status code:
400.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.AwsServiceExceptiondefault UpdateUserPoolClientResponse updateUserPoolClient(UpdateUserPoolClientRequest updateUserPoolClientRequest) throws ResourceNotFoundException, InvalidParameterException, ConcurrentModificationException, TooManyRequestsException, NotAuthorizedException, ScopeDoesNotExistException, InvalidOAuthFlowException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Updates the specified user pool app client with the specified attributes. You can get a list of the current user pool app client settings using DescribeUserPoolClient.
If you don't provide a value for an attribute, it will be set to the default value.
You can also use this operation to enable token revocation for user pool clients. For more information about revoking tokens, see RevokeToken.
updateUserPoolClientRequest - Represents the request to update the user pool client.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ConcurrentModificationException - This exception is thrown if two or more modifications are happening concurrently.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 isn't authorized.ScopeDoesNotExistException - This exception is thrown when the specified scope doesn't exist.InvalidOAuthFlowException - This exception is thrown when the specified OAuth flow is not valid.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.AwsServiceExceptiondefault UpdateUserPoolClientResponse updateUserPoolClient(Consumer<UpdateUserPoolClientRequest.Builder> updateUserPoolClientRequest) throws ResourceNotFoundException, InvalidParameterException, ConcurrentModificationException, TooManyRequestsException, NotAuthorizedException, ScopeDoesNotExistException, InvalidOAuthFlowException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Updates the specified user pool app client with the specified attributes. You can get a list of the current user pool app client settings using DescribeUserPoolClient.
If you don't provide a value for an attribute, it will be set to the default value.
You can also use this operation to enable token revocation for user pool clients. For more information about revoking tokens, see RevokeToken.
This is a convenience which creates an instance of the UpdateUserPoolClientRequest.Builder avoiding the
need to create one manually via UpdateUserPoolClientRequest.builder()
updateUserPoolClientRequest - A Consumer that will call methods on UpdateUserPoolClientRequest.Builder to create a
request. Represents the request to update the user pool client.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ConcurrentModificationException - This exception is thrown if two or more modifications are happening concurrently.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 isn't authorized.ScopeDoesNotExistException - This exception is thrown when the specified scope doesn't exist.InvalidOAuthFlowException - This exception is thrown when the specified OAuth flow is not valid.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.AwsServiceExceptiondefault UpdateUserPoolDomainResponse updateUserPoolDomain(UpdateUserPoolDomainRequest updateUserPoolDomainRequest) throws InvalidParameterException, NotAuthorizedException, ResourceNotFoundException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.
You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You can't use it to change the domain for a user pool.
A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and sign-in pages for your application. When you set up a custom domain, you provide a certificate that you manage with Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain.
Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same, and your custom domain uses the new certificate automatically.
However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide this ARN to Amazon Cognito.
When you add your new certificate in ACM, you must choose US East (N. Virginia) as the Amazon Web Services Region.
After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain.
For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
updateUserPoolDomainRequest - The UpdateUserPoolDomain request input.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException - This exception is thrown when a user isn't authorized.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.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.AwsServiceExceptiondefault UpdateUserPoolDomainResponse updateUserPoolDomain(Consumer<UpdateUserPoolDomainRequest.Builder> updateUserPoolDomainRequest) throws InvalidParameterException, NotAuthorizedException, ResourceNotFoundException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.
You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You can't use it to change the domain for a user pool.
A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and sign-in pages for your application. When you set up a custom domain, you provide a certificate that you manage with Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain.
Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same, and your custom domain uses the new certificate automatically.
However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide this ARN to Amazon Cognito.
When you add your new certificate in ACM, you must choose US East (N. Virginia) as the Amazon Web Services Region.
After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain.
For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
This is a convenience which creates an instance of the UpdateUserPoolDomainRequest.Builder avoiding the
need to create one manually via UpdateUserPoolDomainRequest.builder()
updateUserPoolDomainRequest - A Consumer that will call methods on UpdateUserPoolDomainRequest.Builder to create a
request. The UpdateUserPoolDomain request input.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException - This exception is thrown when a user isn't authorized.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.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.AwsServiceExceptiondefault VerifySoftwareTokenResponse verifySoftwareToken(VerifySoftwareTokenRequest verifySoftwareTokenRequest) throws InvalidParameterException, ResourceNotFoundException, InvalidUserPoolConfigurationException, NotAuthorizedException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, EnableSoftwareTokenMfaException, SoftwareTokenMfaNotFoundException, CodeMismatchException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Use this API to register a user's entered time-based one-time password (TOTP) code and mark the user's software token MFA status as "verified" if successful. The request takes an access token or a session string, but not both.
verifySoftwareTokenRequest - InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.InvalidUserPoolConfigurationException - This exception is thrown when the user pool configuration is not valid.NotAuthorizedException - This exception is thrown when a user isn't 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 isn't found.UserNotConfirmedException - This exception is thrown when a user isn't confirmed successfully.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.EnableSoftwareTokenMfaException - This exception is thrown when there is a code mismatch and the service fails to configure the software
token TOTP multi-factor authentication (MFA).NotAuthorizedException - This exception is thrown when a user isn't authorized.SoftwareTokenMfaNotFoundException - This exception is thrown when the software token time-based one-time password (TOTP) multi-factor
authentication (MFA) isn't activated for the user pool.CodeMismatchException - This exception is thrown if the provided code doesn't match what the server was expecting.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.AwsServiceExceptiondefault VerifySoftwareTokenResponse verifySoftwareToken(Consumer<VerifySoftwareTokenRequest.Builder> verifySoftwareTokenRequest) throws InvalidParameterException, ResourceNotFoundException, InvalidUserPoolConfigurationException, NotAuthorizedException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, EnableSoftwareTokenMfaException, SoftwareTokenMfaNotFoundException, CodeMismatchException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Use this API to register a user's entered time-based one-time password (TOTP) code and mark the user's software token MFA status as "verified" if successful. The request takes an access token or a session string, but not both.
This is a convenience which creates an instance of the VerifySoftwareTokenRequest.Builder avoiding the
need to create one manually via VerifySoftwareTokenRequest.builder()
verifySoftwareTokenRequest - A Consumer that will call methods on VerifySoftwareTokenRequest.Builder to create a
request.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.InvalidUserPoolConfigurationException - This exception is thrown when the user pool configuration is not valid.NotAuthorizedException - This exception is thrown when a user isn't 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 isn't found.UserNotConfirmedException - This exception is thrown when a user isn't confirmed successfully.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.EnableSoftwareTokenMfaException - This exception is thrown when there is a code mismatch and the service fails to configure the software
token TOTP multi-factor authentication (MFA).NotAuthorizedException - This exception is thrown when a user isn't authorized.SoftwareTokenMfaNotFoundException - This exception is thrown when the software token time-based one-time password (TOTP) multi-factor
authentication (MFA) isn't activated for the user pool.CodeMismatchException - This exception is thrown if the provided code doesn't match what the server was expecting.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.AwsServiceExceptiondefault VerifyUserAttributeResponse verifyUserAttribute(VerifyUserAttributeRequest verifyUserAttributeRequest) throws ResourceNotFoundException, InvalidParameterException, CodeMismatchException, ExpiredCodeException, NotAuthorizedException, TooManyRequestsException, LimitExceededException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AliasExistsException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Verifies the specified user attributes in the user pool.
If your user pool requires verification before Amazon Cognito updates the attribute value, VerifyUserAttribute updates the affected attribute to its pending value. For more information, see UserAttributeUpdateSettingsType.
verifyUserAttributeRequest - Represents the request to verify user attributes.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.CodeMismatchException - This exception is thrown if the provided code doesn't match what the server was expecting.ExpiredCodeException - This exception is thrown if a code has expired.NotAuthorizedException - This exception is thrown when a user isn't 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 Amazon Web Services resource.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user isn't found.UserNotConfirmedException - This exception is thrown when a user isn't confirmed successfully.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.AliasExistsException - This exception is thrown when a user tries to confirm the account with an email address or phone number
that has already been supplied as an alias for a different user profile. This exception indicates that an
account with this email address or phone already exists in a user pool that you've configured to use
email address or phone number as a sign-in alias.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.AwsServiceExceptiondefault VerifyUserAttributeResponse verifyUserAttribute(Consumer<VerifyUserAttributeRequest.Builder> verifyUserAttributeRequest) throws ResourceNotFoundException, InvalidParameterException, CodeMismatchException, ExpiredCodeException, NotAuthorizedException, TooManyRequestsException, LimitExceededException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AliasExistsException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Verifies the specified user attributes in the user pool.
If your user pool requires verification before Amazon Cognito updates the attribute value, VerifyUserAttribute updates the affected attribute to its pending value. For more information, see UserAttributeUpdateSettingsType.
This is a convenience which creates an instance of the VerifyUserAttributeRequest.Builder avoiding the
need to create one manually via VerifyUserAttributeRequest.builder()
verifyUserAttributeRequest - A Consumer that will call methods on VerifyUserAttributeRequest.Builder to create a
request. Represents the request to verify user attributes.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service can't find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.CodeMismatchException - This exception is thrown if the provided code doesn't match what the server was expecting.ExpiredCodeException - This exception is thrown if a code has expired.NotAuthorizedException - This exception is thrown when a user isn't 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 Amazon Web Services resource.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user isn't found.UserNotConfirmedException - This exception is thrown when a user isn't confirmed successfully.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.AliasExistsException - This exception is thrown when a user tries to confirm the account with an email address or phone number
that has already been supplied as an alias for a different user profile. This exception indicates that an
account with this email address or phone already exists in a user pool that you've configured to use
email address or phone number as a sign-in alias.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.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2022. All rights reserved.