Interface CognitoIdentityProviderClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface CognitoIdentityProviderClient extends AwsClient
Service client for accessing Amazon Cognito Identity Provider. This can be created using the staticbuilder()method.With the Amazon Cognito user pools API, you can configure user pools and authenticate users. To authenticate users from third-party identity providers (IdPs) in this API, you can link IdP users to native user profiles. Learn more about the authentication and authorization of federated users at Adding user pool sign-in through a third party and in the User pool federation endpoints and hosted UI reference.
This API reference provides detailed information about API operations and object types in Amazon Cognito.
Along with resource management operations, the Amazon Cognito user pools API includes classes of operations and authorization models for client-side and server-side authentication of users. You can interact with operations in the Amazon Cognito user pools API as any of the following subjects.
-
An administrator who wants to configure user pools, app clients, users, groups, or other user pool functions.
-
A server-side app, like a web application, that wants to use its Amazon Web Services privileges to manage, authenticate, or authorize a user.
-
A client-side app, like a mobile app, that wants to make unauthenticated requests to manage, authenticate, or authorize a user.
For more information, see Using the Amazon Cognito user pools API and user pool endpoints in the Amazon Cognito Developer Guide.
With your Amazon Web Services SDK, you can build the logic to support operational flows in every use case for this API. You can also make direct REST API requests to Amazon Cognito user pools service endpoints. The following links can get you started with the
CognitoIdentityProviderclient in other supported Amazon Web Services SDKs.To get started with an Amazon Web Services SDK, see Tools to Build on Amazon Web Services. For example actions and scenarios, see Code examples for Amazon Cognito Identity Provider using Amazon Web Services SDKs.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description default AddCustomAttributesResponseaddCustomAttributes(Consumer<AddCustomAttributesRequest.Builder> addCustomAttributesRequest)Adds additional user attributes to the user pool schema.default AddCustomAttributesResponseaddCustomAttributes(AddCustomAttributesRequest addCustomAttributesRequest)Adds additional user attributes to the user pool schema.default AdminAddUserToGroupResponseadminAddUserToGroup(Consumer<AdminAddUserToGroupRequest.Builder> adminAddUserToGroupRequest)Adds a user to a group.default AdminAddUserToGroupResponseadminAddUserToGroup(AdminAddUserToGroupRequest adminAddUserToGroupRequest)Adds a user to a group.default AdminConfirmSignUpResponseadminConfirmSignUp(Consumer<AdminConfirmSignUpRequest.Builder> adminConfirmSignUpRequest)Confirms user sign-up as an administrator.default AdminConfirmSignUpResponseadminConfirmSignUp(AdminConfirmSignUpRequest adminConfirmSignUpRequest)Confirms user sign-up as an administrator.default AdminCreateUserResponseadminCreateUser(Consumer<AdminCreateUserRequest.Builder> adminCreateUserRequest)Creates a new user in the specified user pool.default AdminCreateUserResponseadminCreateUser(AdminCreateUserRequest adminCreateUserRequest)Creates a new user in the specified user pool.default AdminDeleteUserResponseadminDeleteUser(Consumer<AdminDeleteUserRequest.Builder> adminDeleteUserRequest)Deletes a user profile in your user pool.default AdminDeleteUserResponseadminDeleteUser(AdminDeleteUserRequest adminDeleteUserRequest)Deletes a user profile in your user pool.default AdminDeleteUserAttributesResponseadminDeleteUserAttributes(Consumer<AdminDeleteUserAttributesRequest.Builder> adminDeleteUserAttributesRequest)Deletes attribute values from a user.default AdminDeleteUserAttributesResponseadminDeleteUserAttributes(AdminDeleteUserAttributesRequest adminDeleteUserAttributesRequest)Deletes attribute values from a user.default AdminDisableProviderForUserResponseadminDisableProviderForUser(Consumer<AdminDisableProviderForUserRequest.Builder> adminDisableProviderForUserRequest)Prevents the user from signing in with the specified external (SAML or social) identity provider (IdP).default AdminDisableProviderForUserResponseadminDisableProviderForUser(AdminDisableProviderForUserRequest adminDisableProviderForUserRequest)Prevents the user from signing in with the specified external (SAML or social) identity provider (IdP).default AdminDisableUserResponseadminDisableUser(Consumer<AdminDisableUserRequest.Builder> adminDisableUserRequest)Deactivates a user profile and revokes all access tokens for the user.default AdminDisableUserResponseadminDisableUser(AdminDisableUserRequest adminDisableUserRequest)Deactivates a user profile and revokes all access tokens for the user.default AdminEnableUserResponseadminEnableUser(Consumer<AdminEnableUserRequest.Builder> adminEnableUserRequest)Activate sign-in for a user profile that previously had sign-in access disabled.default AdminEnableUserResponseadminEnableUser(AdminEnableUserRequest adminEnableUserRequest)Activate sign-in for a user profile that previously had sign-in access disabled.default AdminForgetDeviceResponseadminForgetDevice(Consumer<AdminForgetDeviceRequest.Builder> adminForgetDeviceRequest)Forgets, or deletes, a remembered device from a user's profile.default AdminForgetDeviceResponseadminForgetDevice(AdminForgetDeviceRequest adminForgetDeviceRequest)Forgets, or deletes, a remembered device from a user's profile.default AdminGetDeviceResponseadminGetDevice(Consumer<AdminGetDeviceRequest.Builder> adminGetDeviceRequest)Given the device key, returns details for a user' device.default AdminGetDeviceResponseadminGetDevice(AdminGetDeviceRequest adminGetDeviceRequest)Given the device key, returns details for a user' device.default AdminGetUserResponseadminGetUser(Consumer<AdminGetUserRequest.Builder> adminGetUserRequest)Given the username, returns details about a user profile in a user pool.default AdminGetUserResponseadminGetUser(AdminGetUserRequest adminGetUserRequest)Given the username, returns details about a user profile in a user pool.default AdminInitiateAuthResponseadminInitiateAuth(Consumer<AdminInitiateAuthRequest.Builder> adminInitiateAuthRequest)Starts sign-in for applications with a server-side component, for example a traditional web application.default AdminInitiateAuthResponseadminInitiateAuth(AdminInitiateAuthRequest adminInitiateAuthRequest)Starts sign-in for applications with a server-side component, for example a traditional web application.default AdminLinkProviderForUserResponseadminLinkProviderForUser(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 AdminLinkProviderForUserResponseadminLinkProviderForUser(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 AdminListDevicesResponseadminListDevices(Consumer<AdminListDevicesRequest.Builder> adminListDevicesRequest)Lists a user's registered devices.default AdminListDevicesResponseadminListDevices(AdminListDevicesRequest adminListDevicesRequest)Lists a user's registered devices.default AdminListGroupsForUserResponseadminListGroupsForUser(Consumer<AdminListGroupsForUserRequest.Builder> adminListGroupsForUserRequest)Lists the groups that a user belongs to.default AdminListGroupsForUserResponseadminListGroupsForUser(AdminListGroupsForUserRequest adminListGroupsForUserRequest)Lists the groups that a user belongs to.default AdminListGroupsForUserIterableadminListGroupsForUserPaginator(Consumer<AdminListGroupsForUserRequest.Builder> adminListGroupsForUserRequest)This is a variant ofadminListGroupsForUser(software.amazon.awssdk.services.cognitoidentityprovider.model.AdminListGroupsForUserRequest)operation.default AdminListGroupsForUserIterableadminListGroupsForUserPaginator(AdminListGroupsForUserRequest adminListGroupsForUserRequest)This is a variant ofadminListGroupsForUser(software.amazon.awssdk.services.cognitoidentityprovider.model.AdminListGroupsForUserRequest)operation.default AdminListUserAuthEventsResponseadminListUserAuthEvents(Consumer<AdminListUserAuthEventsRequest.Builder> adminListUserAuthEventsRequest)Requests a history of user activity and any risks detected as part of Amazon Cognito threat protection.default AdminListUserAuthEventsResponseadminListUserAuthEvents(AdminListUserAuthEventsRequest adminListUserAuthEventsRequest)Requests a history of user activity and any risks detected as part of Amazon Cognito threat protection.default AdminListUserAuthEventsIterableadminListUserAuthEventsPaginator(Consumer<AdminListUserAuthEventsRequest.Builder> adminListUserAuthEventsRequest)This is a variant ofadminListUserAuthEvents(software.amazon.awssdk.services.cognitoidentityprovider.model.AdminListUserAuthEventsRequest)operation.default AdminListUserAuthEventsIterableadminListUserAuthEventsPaginator(AdminListUserAuthEventsRequest adminListUserAuthEventsRequest)This is a variant ofadminListUserAuthEvents(software.amazon.awssdk.services.cognitoidentityprovider.model.AdminListUserAuthEventsRequest)operation.default AdminRemoveUserFromGroupResponseadminRemoveUserFromGroup(Consumer<AdminRemoveUserFromGroupRequest.Builder> adminRemoveUserFromGroupRequest)Given a username and a group name.default AdminRemoveUserFromGroupResponseadminRemoveUserFromGroup(AdminRemoveUserFromGroupRequest adminRemoveUserFromGroupRequest)Given a username and a group name.default AdminResetUserPasswordResponseadminResetUserPassword(Consumer<AdminResetUserPasswordRequest.Builder> adminResetUserPasswordRequest)Resets the specified user's password in a user pool.default AdminResetUserPasswordResponseadminResetUserPassword(AdminResetUserPasswordRequest adminResetUserPasswordRequest)Resets the specified user's password in a user pool.default AdminRespondToAuthChallengeResponseadminRespondToAuthChallenge(Consumer<AdminRespondToAuthChallengeRequest.Builder> adminRespondToAuthChallengeRequest)Some API operations in a user pool generate a challenge, like a prompt for an MFA code, for device authentication that bypasses MFA, or for a custom authentication challenge.default AdminRespondToAuthChallengeResponseadminRespondToAuthChallenge(AdminRespondToAuthChallengeRequest adminRespondToAuthChallengeRequest)Some API operations in a user pool generate a challenge, like a prompt for an MFA code, for device authentication that bypasses MFA, or for a custom authentication challenge.default AdminSetUserMfaPreferenceResponseadminSetUserMFAPreference(Consumer<AdminSetUserMfaPreferenceRequest.Builder> adminSetUserMfaPreferenceRequest)Sets the user's multi-factor authentication (MFA) preference, including which MFA options are activated, and if any are preferred.default AdminSetUserMfaPreferenceResponseadminSetUserMFAPreference(AdminSetUserMfaPreferenceRequest adminSetUserMfaPreferenceRequest)Sets the user's multi-factor authentication (MFA) preference, including which MFA options are activated, and if any are preferred.default AdminSetUserPasswordResponseadminSetUserPassword(Consumer<AdminSetUserPasswordRequest.Builder> adminSetUserPasswordRequest)Sets the specified user's password in a user pool.default AdminSetUserPasswordResponseadminSetUserPassword(AdminSetUserPasswordRequest adminSetUserPasswordRequest)Sets the specified user's password in a user pool.default AdminSetUserSettingsResponseadminSetUserSettings(Consumer<AdminSetUserSettingsRequest.Builder> adminSetUserSettingsRequest)This action is no longer supported. You can use it to configure only SMS MFA.default AdminSetUserSettingsResponseadminSetUserSettings(AdminSetUserSettingsRequest adminSetUserSettingsRequest)This action is no longer supported. You can use it to configure only SMS MFA.default AdminUpdateAuthEventFeedbackResponseadminUpdateAuthEventFeedback(Consumer<AdminUpdateAuthEventFeedbackRequest.Builder> adminUpdateAuthEventFeedbackRequest)Provides feedback for an authentication event indicating if it was from a valid user.default AdminUpdateAuthEventFeedbackResponseadminUpdateAuthEventFeedback(AdminUpdateAuthEventFeedbackRequest adminUpdateAuthEventFeedbackRequest)Provides feedback for an authentication event indicating if it was from a valid user.default AdminUpdateDeviceStatusResponseadminUpdateDeviceStatus(Consumer<AdminUpdateDeviceStatusRequest.Builder> adminUpdateDeviceStatusRequest)Updates the status of a user's device so that it is marked as remembered or not remembered for the purpose of device authentication.default AdminUpdateDeviceStatusResponseadminUpdateDeviceStatus(AdminUpdateDeviceStatusRequest adminUpdateDeviceStatusRequest)Updates the status of a user's device so that it is marked as remembered or not remembered for the purpose of device authentication.default AdminUpdateUserAttributesResponseadminUpdateUserAttributes(Consumer<AdminUpdateUserAttributesRequest.Builder> adminUpdateUserAttributesRequest)default AdminUpdateUserAttributesResponseadminUpdateUserAttributes(AdminUpdateUserAttributesRequest adminUpdateUserAttributesRequest)default AdminUserGlobalSignOutResponseadminUserGlobalSignOut(Consumer<AdminUserGlobalSignOutRequest.Builder> adminUserGlobalSignOutRequest)Invalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user.default AdminUserGlobalSignOutResponseadminUserGlobalSignOut(AdminUserGlobalSignOutRequest adminUserGlobalSignOutRequest)Invalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user.default AssociateSoftwareTokenResponseassociateSoftwareToken(Consumer<AssociateSoftwareTokenRequest.Builder> associateSoftwareTokenRequest)Begins setup of time-based one-time password (TOTP) multi-factor authentication (MFA) for a user, with a unique private key that Amazon Cognito generates and returns in the API response.default AssociateSoftwareTokenResponseassociateSoftwareToken(AssociateSoftwareTokenRequest associateSoftwareTokenRequest)Begins setup of time-based one-time password (TOTP) multi-factor authentication (MFA) for a user, with a unique private key that Amazon Cognito generates and returns in the API response.static CognitoIdentityProviderClientBuilderbuilder()Create a builder that can be used to configure and create aCognitoIdentityProviderClient.default ChangePasswordResponsechangePassword(Consumer<ChangePasswordRequest.Builder> changePasswordRequest)Changes the password for a specified user in a user pool.default ChangePasswordResponsechangePassword(ChangePasswordRequest changePasswordRequest)Changes the password for a specified user in a user pool.default CompleteWebAuthnRegistrationResponsecompleteWebAuthnRegistration(Consumer<CompleteWebAuthnRegistrationRequest.Builder> completeWebAuthnRegistrationRequest)Completes registration of a passkey authenticator for the current user.default CompleteWebAuthnRegistrationResponsecompleteWebAuthnRegistration(CompleteWebAuthnRegistrationRequest completeWebAuthnRegistrationRequest)Completes registration of a passkey authenticator for the current user.default ConfirmDeviceResponseconfirmDevice(Consumer<ConfirmDeviceRequest.Builder> confirmDeviceRequest)Confirms a device that a user wants to remember.default ConfirmDeviceResponseconfirmDevice(ConfirmDeviceRequest confirmDeviceRequest)Confirms a device that a user wants to remember.default ConfirmForgotPasswordResponseconfirmForgotPassword(Consumer<ConfirmForgotPasswordRequest.Builder> confirmForgotPasswordRequest)This public API operation accepts a confirmation code that Amazon Cognito sent to a user and accepts a new password for that user.default ConfirmForgotPasswordResponseconfirmForgotPassword(ConfirmForgotPasswordRequest confirmForgotPasswordRequest)This public API operation accepts a confirmation code that Amazon Cognito sent to a user and accepts a new password for that user.default ConfirmSignUpResponseconfirmSignUp(Consumer<ConfirmSignUpRequest.Builder> confirmSignUpRequest)This public API operation submits a code that Amazon Cognito sent to your user when they signed up in your user pool via the SignUp API operation.default ConfirmSignUpResponseconfirmSignUp(ConfirmSignUpRequest confirmSignUpRequest)This public API operation submits a code that Amazon Cognito sent to your user when they signed up in your user pool via the SignUp API operation.static CognitoIdentityProviderClientcreate()Create aCognitoIdentityProviderClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateGroupResponsecreateGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest)Creates a new group in the specified user pool.default CreateGroupResponsecreateGroup(CreateGroupRequest createGroupRequest)Creates a new group in the specified user pool.default CreateIdentityProviderResponsecreateIdentityProvider(Consumer<CreateIdentityProviderRequest.Builder> createIdentityProviderRequest)Adds a configuration and trust relationship between a third-party identity provider (IdP) and a user pool.default CreateIdentityProviderResponsecreateIdentityProvider(CreateIdentityProviderRequest createIdentityProviderRequest)Adds a configuration and trust relationship between a third-party identity provider (IdP) and a user pool.default CreateManagedLoginBrandingResponsecreateManagedLoginBranding(Consumer<CreateManagedLoginBrandingRequest.Builder> createManagedLoginBrandingRequest)Creates a new set of branding settings for a user pool style and associates it with an app client.default CreateManagedLoginBrandingResponsecreateManagedLoginBranding(CreateManagedLoginBrandingRequest createManagedLoginBrandingRequest)Creates a new set of branding settings for a user pool style and associates it with an app client.default CreateResourceServerResponsecreateResourceServer(Consumer<CreateResourceServerRequest.Builder> createResourceServerRequest)Creates a new OAuth2.0 resource server and defines custom scopes within it.default CreateResourceServerResponsecreateResourceServer(CreateResourceServerRequest createResourceServerRequest)Creates a new OAuth2.0 resource server and defines custom scopes within it.default CreateUserImportJobResponsecreateUserImportJob(Consumer<CreateUserImportJobRequest.Builder> createUserImportJobRequest)Creates a user import job.default CreateUserImportJobResponsecreateUserImportJob(CreateUserImportJobRequest createUserImportJobRequest)Creates a user import job.default CreateUserPoolResponsecreateUserPool(Consumer<CreateUserPoolRequest.Builder> createUserPoolRequest)default CreateUserPoolResponsecreateUserPool(CreateUserPoolRequest createUserPoolRequest)default CreateUserPoolClientResponsecreateUserPoolClient(Consumer<CreateUserPoolClientRequest.Builder> createUserPoolClientRequest)Creates an app client in a user pool.default CreateUserPoolClientResponsecreateUserPoolClient(CreateUserPoolClientRequest createUserPoolClientRequest)Creates an app client in a user pool.default CreateUserPoolDomainResponsecreateUserPoolDomain(Consumer<CreateUserPoolDomainRequest.Builder> createUserPoolDomainRequest)A user pool domain hosts managed login, an authorization server and web server for authentication in your application.default CreateUserPoolDomainResponsecreateUserPoolDomain(CreateUserPoolDomainRequest createUserPoolDomainRequest)A user pool domain hosts managed login, an authorization server and web server for authentication in your application.default DeleteGroupResponsedeleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)Deletes a group from the specified user pool.default DeleteGroupResponsedeleteGroup(DeleteGroupRequest deleteGroupRequest)Deletes a group from the specified user pool.default DeleteIdentityProviderResponsedeleteIdentityProvider(Consumer<DeleteIdentityProviderRequest.Builder> deleteIdentityProviderRequest)Deletes a user pool identity provider (IdP).default DeleteIdentityProviderResponsedeleteIdentityProvider(DeleteIdentityProviderRequest deleteIdentityProviderRequest)Deletes a user pool identity provider (IdP).default DeleteManagedLoginBrandingResponsedeleteManagedLoginBranding(Consumer<DeleteManagedLoginBrandingRequest.Builder> deleteManagedLoginBrandingRequest)Deletes a managed login branding style.default DeleteManagedLoginBrandingResponsedeleteManagedLoginBranding(DeleteManagedLoginBrandingRequest deleteManagedLoginBrandingRequest)Deletes a managed login branding style.default DeleteResourceServerResponsedeleteResourceServer(Consumer<DeleteResourceServerRequest.Builder> deleteResourceServerRequest)Deletes a resource server.default DeleteResourceServerResponsedeleteResourceServer(DeleteResourceServerRequest deleteResourceServerRequest)Deletes a resource server.default DeleteUserResponsedeleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)Self-deletes a user profile.default DeleteUserResponsedeleteUser(DeleteUserRequest deleteUserRequest)Self-deletes a user profile.default DeleteUserAttributesResponsedeleteUserAttributes(Consumer<DeleteUserAttributesRequest.Builder> deleteUserAttributesRequest)Self-deletes attributes for a user.default DeleteUserAttributesResponsedeleteUserAttributes(DeleteUserAttributesRequest deleteUserAttributesRequest)Self-deletes attributes for a user.default DeleteUserPoolResponsedeleteUserPool(Consumer<DeleteUserPoolRequest.Builder> deleteUserPoolRequest)Deletes a user pool.default DeleteUserPoolResponsedeleteUserPool(DeleteUserPoolRequest deleteUserPoolRequest)Deletes a user pool.default DeleteUserPoolClientResponsedeleteUserPoolClient(Consumer<DeleteUserPoolClientRequest.Builder> deleteUserPoolClientRequest)Deletes a user pool app client.default DeleteUserPoolClientResponsedeleteUserPoolClient(DeleteUserPoolClientRequest deleteUserPoolClientRequest)Deletes a user pool app client.default DeleteUserPoolDomainResponsedeleteUserPoolDomain(Consumer<DeleteUserPoolDomainRequest.Builder> deleteUserPoolDomainRequest)Given a user pool ID and domain identifier, deletes a user pool domain.default DeleteUserPoolDomainResponsedeleteUserPoolDomain(DeleteUserPoolDomainRequest deleteUserPoolDomainRequest)Given a user pool ID and domain identifier, deletes a user pool domain.default DeleteWebAuthnCredentialResponsedeleteWebAuthnCredential(Consumer<DeleteWebAuthnCredentialRequest.Builder> deleteWebAuthnCredentialRequest)Deletes a registered passkey, or webauthN, authenticator for the currently signed-in user.default DeleteWebAuthnCredentialResponsedeleteWebAuthnCredential(DeleteWebAuthnCredentialRequest deleteWebAuthnCredentialRequest)Deletes a registered passkey, or webauthN, authenticator for the currently signed-in user.default DescribeIdentityProviderResponsedescribeIdentityProvider(Consumer<DescribeIdentityProviderRequest.Builder> describeIdentityProviderRequest)Given a user pool ID and identity provider (IdP) name, returns details about the IdP.default DescribeIdentityProviderResponsedescribeIdentityProvider(DescribeIdentityProviderRequest describeIdentityProviderRequest)Given a user pool ID and identity provider (IdP) name, returns details about the IdP.default DescribeManagedLoginBrandingResponsedescribeManagedLoginBranding(Consumer<DescribeManagedLoginBrandingRequest.Builder> describeManagedLoginBrandingRequest)Given the ID of a managed login branding style, returns detailed information about the style.default DescribeManagedLoginBrandingResponsedescribeManagedLoginBranding(DescribeManagedLoginBrandingRequest describeManagedLoginBrandingRequest)Given the ID of a managed login branding style, returns detailed information about the style.default DescribeManagedLoginBrandingByClientResponsedescribeManagedLoginBrandingByClient(Consumer<DescribeManagedLoginBrandingByClientRequest.Builder> describeManagedLoginBrandingByClientRequest)Given the ID of a user pool app client, returns detailed information about the style assigned to the app client.default DescribeManagedLoginBrandingByClientResponsedescribeManagedLoginBrandingByClient(DescribeManagedLoginBrandingByClientRequest describeManagedLoginBrandingByClientRequest)Given the ID of a user pool app client, returns detailed information about the style assigned to the app client.default DescribeResourceServerResponsedescribeResourceServer(Consumer<DescribeResourceServerRequest.Builder> describeResourceServerRequest)Describes a resource server.default DescribeResourceServerResponsedescribeResourceServer(DescribeResourceServerRequest describeResourceServerRequest)Describes a resource server.default DescribeRiskConfigurationResponsedescribeRiskConfiguration(Consumer<DescribeRiskConfigurationRequest.Builder> describeRiskConfigurationRequest)Given an app client or user pool ID where threat protection is configured, describes the risk configuration.default DescribeRiskConfigurationResponsedescribeRiskConfiguration(DescribeRiskConfigurationRequest describeRiskConfigurationRequest)Given an app client or user pool ID where threat protection is configured, describes the risk configuration.default DescribeUserImportJobResponsedescribeUserImportJob(Consumer<DescribeUserImportJobRequest.Builder> describeUserImportJobRequest)Describes a user import job.default DescribeUserImportJobResponsedescribeUserImportJob(DescribeUserImportJobRequest describeUserImportJobRequest)Describes a user import job.default DescribeUserPoolResponsedescribeUserPool(Consumer<DescribeUserPoolRequest.Builder> describeUserPoolRequest)Given a user pool ID, returns configuration information.default DescribeUserPoolResponsedescribeUserPool(DescribeUserPoolRequest describeUserPoolRequest)Given a user pool ID, returns configuration information.default DescribeUserPoolClientResponsedescribeUserPoolClient(Consumer<DescribeUserPoolClientRequest.Builder> describeUserPoolClientRequest)Given an app client ID, returns configuration information.default DescribeUserPoolClientResponsedescribeUserPoolClient(DescribeUserPoolClientRequest describeUserPoolClientRequest)Given an app client ID, returns configuration information.default DescribeUserPoolDomainResponsedescribeUserPoolDomain(Consumer<DescribeUserPoolDomainRequest.Builder> describeUserPoolDomainRequest)Given a user pool domain name, returns information about the domain configuration.default DescribeUserPoolDomainResponsedescribeUserPoolDomain(DescribeUserPoolDomainRequest describeUserPoolDomainRequest)Given a user pool domain name, returns information about the domain configuration.default ForgetDeviceResponseforgetDevice(Consumer<ForgetDeviceRequest.Builder> forgetDeviceRequest)Forgets the specified device.default ForgetDeviceResponseforgetDevice(ForgetDeviceRequest forgetDeviceRequest)Forgets the specified device.default ForgotPasswordResponseforgotPassword(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 ForgotPasswordResponseforgotPassword(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 GetCsvHeaderResponsegetCSVHeader(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 GetCsvHeaderResponsegetCSVHeader(GetCsvHeaderRequest getCsvHeaderRequest)Gets the header information for the comma-separated value (CSV) file to be used as input for the user import job.default GetDeviceResponsegetDevice(Consumer<GetDeviceRequest.Builder> getDeviceRequest)Gets the device.default GetDeviceResponsegetDevice(GetDeviceRequest getDeviceRequest)Gets the device.default GetGroupResponsegetGroup(Consumer<GetGroupRequest.Builder> getGroupRequest)Gets a group.default GetGroupResponsegetGroup(GetGroupRequest getGroupRequest)Gets a group.default GetIdentityProviderByIdentifierResponsegetIdentityProviderByIdentifier(Consumer<GetIdentityProviderByIdentifierRequest.Builder> getIdentityProviderByIdentifierRequest)Gets the specified IdP.default GetIdentityProviderByIdentifierResponsegetIdentityProviderByIdentifier(GetIdentityProviderByIdentifierRequest getIdentityProviderByIdentifierRequest)Gets the specified IdP.default GetLogDeliveryConfigurationResponsegetLogDeliveryConfiguration(Consumer<GetLogDeliveryConfigurationRequest.Builder> getLogDeliveryConfigurationRequest)Gets the logging configuration of a user pool.default GetLogDeliveryConfigurationResponsegetLogDeliveryConfiguration(GetLogDeliveryConfigurationRequest getLogDeliveryConfigurationRequest)Gets the logging configuration of a user pool.default GetSigningCertificateResponsegetSigningCertificate(Consumer<GetSigningCertificateRequest.Builder> getSigningCertificateRequest)This method takes a user pool ID, and returns the signing certificate.default GetSigningCertificateResponsegetSigningCertificate(GetSigningCertificateRequest getSigningCertificateRequest)This method takes a user pool ID, and returns the signing certificate.default GetUiCustomizationResponsegetUICustomization(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 GetUiCustomizationResponsegetUICustomization(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 GetUserResponsegetUser(Consumer<GetUserRequest.Builder> getUserRequest)Gets the user attributes and metadata for a user.default GetUserResponsegetUser(GetUserRequest getUserRequest)Gets the user attributes and metadata for a user.default GetUserAttributeVerificationCodeResponsegetUserAttributeVerificationCode(Consumer<GetUserAttributeVerificationCodeRequest.Builder> getUserAttributeVerificationCodeRequest)Generates a user attribute verification code for the specified attribute name.default GetUserAttributeVerificationCodeResponsegetUserAttributeVerificationCode(GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest)Generates a user attribute verification code for the specified attribute name.default GetUserAuthFactorsResponsegetUserAuthFactors(Consumer<GetUserAuthFactorsRequest.Builder> getUserAuthFactorsRequest)Lists the authentication options for the currently signed-in user.default GetUserAuthFactorsResponsegetUserAuthFactors(GetUserAuthFactorsRequest getUserAuthFactorsRequest)Lists the authentication options for the currently signed-in user.default GetUserPoolMfaConfigResponsegetUserPoolMfaConfig(Consumer<GetUserPoolMfaConfigRequest.Builder> getUserPoolMfaConfigRequest)Gets the user pool multi-factor authentication (MFA) configuration.default GetUserPoolMfaConfigResponsegetUserPoolMfaConfig(GetUserPoolMfaConfigRequest getUserPoolMfaConfigRequest)Gets the user pool multi-factor authentication (MFA) configuration.default GlobalSignOutResponseglobalSignOut(Consumer<GlobalSignOutRequest.Builder> globalSignOutRequest)Invalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user.default GlobalSignOutResponseglobalSignOut(GlobalSignOutRequest globalSignOutRequest)Invalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user.default InitiateAuthResponseinitiateAuth(Consumer<InitiateAuthRequest.Builder> initiateAuthRequest)Initiates sign-in for a user in the Amazon Cognito user directory.default InitiateAuthResponseinitiateAuth(InitiateAuthRequest initiateAuthRequest)Initiates sign-in for a user in the Amazon Cognito user directory.default ListDevicesResponselistDevices(Consumer<ListDevicesRequest.Builder> listDevicesRequest)Lists the sign-in devices that Amazon Cognito has registered to the current user.default ListDevicesResponselistDevices(ListDevicesRequest listDevicesRequest)Lists the sign-in devices that Amazon Cognito has registered to the current user.default ListGroupsResponselistGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest)Lists the groups associated with a user pool.default ListGroupsResponselistGroups(ListGroupsRequest listGroupsRequest)Lists the groups associated with a user pool.default ListGroupsIterablelistGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest)This is a variant oflistGroups(software.amazon.awssdk.services.cognitoidentityprovider.model.ListGroupsRequest)operation.default ListGroupsIterablelistGroupsPaginator(ListGroupsRequest listGroupsRequest)This is a variant oflistGroups(software.amazon.awssdk.services.cognitoidentityprovider.model.ListGroupsRequest)operation.default ListIdentityProvidersResponselistIdentityProviders(Consumer<ListIdentityProvidersRequest.Builder> listIdentityProvidersRequest)Lists information about all IdPs for a user pool.default ListIdentityProvidersResponselistIdentityProviders(ListIdentityProvidersRequest listIdentityProvidersRequest)Lists information about all IdPs for a user pool.default ListIdentityProvidersIterablelistIdentityProvidersPaginator(Consumer<ListIdentityProvidersRequest.Builder> listIdentityProvidersRequest)This is a variant oflistIdentityProviders(software.amazon.awssdk.services.cognitoidentityprovider.model.ListIdentityProvidersRequest)operation.default ListIdentityProvidersIterablelistIdentityProvidersPaginator(ListIdentityProvidersRequest listIdentityProvidersRequest)This is a variant oflistIdentityProviders(software.amazon.awssdk.services.cognitoidentityprovider.model.ListIdentityProvidersRequest)operation.default ListResourceServersResponselistResourceServers(Consumer<ListResourceServersRequest.Builder> listResourceServersRequest)Lists the resource servers for a user pool.default ListResourceServersResponselistResourceServers(ListResourceServersRequest listResourceServersRequest)Lists the resource servers for a user pool.default ListResourceServersIterablelistResourceServersPaginator(Consumer<ListResourceServersRequest.Builder> listResourceServersRequest)This is a variant oflistResourceServers(software.amazon.awssdk.services.cognitoidentityprovider.model.ListResourceServersRequest)operation.default ListResourceServersIterablelistResourceServersPaginator(ListResourceServersRequest listResourceServersRequest)This is a variant oflistResourceServers(software.amazon.awssdk.services.cognitoidentityprovider.model.ListResourceServersRequest)operation.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)Lists the tags that are assigned to an Amazon Cognito user pool.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)Lists the tags that are assigned to an Amazon Cognito user pool.default ListUserImportJobsResponselistUserImportJobs(Consumer<ListUserImportJobsRequest.Builder> listUserImportJobsRequest)Lists user import jobs for a user pool.default ListUserImportJobsResponselistUserImportJobs(ListUserImportJobsRequest listUserImportJobsRequest)Lists user import jobs for a user pool.default ListUserPoolClientsResponselistUserPoolClients(Consumer<ListUserPoolClientsRequest.Builder> listUserPoolClientsRequest)Lists the clients that have been created for the specified user pool.default ListUserPoolClientsResponselistUserPoolClients(ListUserPoolClientsRequest listUserPoolClientsRequest)Lists the clients that have been created for the specified user pool.default ListUserPoolClientsIterablelistUserPoolClientsPaginator(Consumer<ListUserPoolClientsRequest.Builder> listUserPoolClientsRequest)This is a variant oflistUserPoolClients(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUserPoolClientsRequest)operation.default ListUserPoolClientsIterablelistUserPoolClientsPaginator(ListUserPoolClientsRequest listUserPoolClientsRequest)This is a variant oflistUserPoolClients(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUserPoolClientsRequest)operation.default ListUserPoolsResponselistUserPools(Consumer<ListUserPoolsRequest.Builder> listUserPoolsRequest)Lists the user pools associated with an Amazon Web Services account.default ListUserPoolsResponselistUserPools(ListUserPoolsRequest listUserPoolsRequest)Lists the user pools associated with an Amazon Web Services account.default ListUserPoolsIterablelistUserPoolsPaginator(Consumer<ListUserPoolsRequest.Builder> listUserPoolsRequest)This is a variant oflistUserPools(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUserPoolsRequest)operation.default ListUserPoolsIterablelistUserPoolsPaginator(ListUserPoolsRequest listUserPoolsRequest)This is a variant oflistUserPools(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUserPoolsRequest)operation.default ListUsersResponselistUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)Lists users and their basic details in a user pool.default ListUsersResponselistUsers(ListUsersRequest listUsersRequest)Lists users and their basic details in a user pool.default ListUsersInGroupResponselistUsersInGroup(Consumer<ListUsersInGroupRequest.Builder> listUsersInGroupRequest)Lists the users in the specified group.default ListUsersInGroupResponselistUsersInGroup(ListUsersInGroupRequest listUsersInGroupRequest)Lists the users in the specified group.default ListUsersInGroupIterablelistUsersInGroupPaginator(Consumer<ListUsersInGroupRequest.Builder> listUsersInGroupRequest)This is a variant oflistUsersInGroup(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUsersInGroupRequest)operation.default ListUsersInGroupIterablelistUsersInGroupPaginator(ListUsersInGroupRequest listUsersInGroupRequest)This is a variant oflistUsersInGroup(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUsersInGroupRequest)operation.default ListUsersIterablelistUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest)This is a variant oflistUsers(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUsersRequest)operation.default ListUsersIterablelistUsersPaginator(ListUsersRequest listUsersRequest)This is a variant oflistUsers(software.amazon.awssdk.services.cognitoidentityprovider.model.ListUsersRequest)operation.default ListWebAuthnCredentialsResponselistWebAuthnCredentials(Consumer<ListWebAuthnCredentialsRequest.Builder> listWebAuthnCredentialsRequest)Generates a list of the current user's registered passkey, or webauthN, credentials.default ListWebAuthnCredentialsResponselistWebAuthnCredentials(ListWebAuthnCredentialsRequest listWebAuthnCredentialsRequest)Generates a list of the current user's registered passkey, or webauthN, credentials.default ResendConfirmationCodeResponseresendConfirmationCode(Consumer<ResendConfirmationCodeRequest.Builder> resendConfirmationCodeRequest)Resends the confirmation (for confirmation of registration) to a specific user in the user pool.default ResendConfirmationCodeResponseresendConfirmationCode(ResendConfirmationCodeRequest resendConfirmationCodeRequest)Resends the confirmation (for confirmation of registration) to a specific user in the user pool.default RespondToAuthChallengeResponserespondToAuthChallenge(Consumer<RespondToAuthChallengeRequest.Builder> respondToAuthChallengeRequest)Some API operations in a user pool generate a challenge, like a prompt for an MFA code, for device authentication that bypasses MFA, or for a custom authentication challenge.default RespondToAuthChallengeResponserespondToAuthChallenge(RespondToAuthChallengeRequest respondToAuthChallengeRequest)Some API operations in a user pool generate a challenge, like a prompt for an MFA code, for device authentication that bypasses MFA, or for a custom authentication challenge.default RevokeTokenResponserevokeToken(Consumer<RevokeTokenRequest.Builder> revokeTokenRequest)Revokes all of the access tokens generated by, and at the same time as, the specified refresh token.default RevokeTokenResponserevokeToken(RevokeTokenRequest revokeTokenRequest)Revokes all of the access tokens generated by, and at the same time as, the specified refresh token.default CognitoIdentityProviderServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default SetLogDeliveryConfigurationResponsesetLogDeliveryConfiguration(Consumer<SetLogDeliveryConfigurationRequest.Builder> setLogDeliveryConfigurationRequest)Sets up or modifies the logging configuration of a user pool.default SetLogDeliveryConfigurationResponsesetLogDeliveryConfiguration(SetLogDeliveryConfigurationRequest setLogDeliveryConfigurationRequest)Sets up or modifies the logging configuration of a user pool.default SetRiskConfigurationResponsesetRiskConfiguration(Consumer<SetRiskConfigurationRequest.Builder> setRiskConfigurationRequest)Configures actions on detected risks.default SetRiskConfigurationResponsesetRiskConfiguration(SetRiskConfigurationRequest setRiskConfigurationRequest)Configures actions on detected risks.default SetUiCustomizationResponsesetUICustomization(Consumer<SetUiCustomizationRequest.Builder> setUiCustomizationRequest)Sets the user interface (UI) customization information for a user pool's built-in app UI.default SetUiCustomizationResponsesetUICustomization(SetUiCustomizationRequest setUiCustomizationRequest)Sets the user interface (UI) customization information for a user pool's built-in app UI.default SetUserMfaPreferenceResponsesetUserMFAPreference(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 SetUserMfaPreferenceResponsesetUserMFAPreference(SetUserMfaPreferenceRequest setUserMfaPreferenceRequest)Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are activated and if any are preferred.default SetUserPoolMfaConfigResponsesetUserPoolMfaConfig(Consumer<SetUserPoolMfaConfigRequest.Builder> setUserPoolMfaConfigRequest)Sets the user pool multi-factor authentication (MFA) and passkey configuration.default SetUserPoolMfaConfigResponsesetUserPoolMfaConfig(SetUserPoolMfaConfigRequest setUserPoolMfaConfigRequest)Sets the user pool multi-factor authentication (MFA) and passkey configuration.default SetUserSettingsResponsesetUserSettings(Consumer<SetUserSettingsRequest.Builder> setUserSettingsRequest)This action is no longer supported. You can use it to configure only SMS MFA.default SetUserSettingsResponsesetUserSettings(SetUserSettingsRequest setUserSettingsRequest)This action is no longer supported. You can use it to configure only SMS MFA.default SignUpResponsesignUp(Consumer<SignUpRequest.Builder> signUpRequest)Registers the user in the specified user pool and creates a user name, password, and user attributes.default SignUpResponsesignUp(SignUpRequest signUpRequest)Registers the user in the specified user pool and creates a user name, password, and user attributes.default StartUserImportJobResponsestartUserImportJob(Consumer<StartUserImportJobRequest.Builder> startUserImportJobRequest)Starts the user import.default StartUserImportJobResponsestartUserImportJob(StartUserImportJobRequest startUserImportJobRequest)Starts the user import.default StartWebAuthnRegistrationResponsestartWebAuthnRegistration(Consumer<StartWebAuthnRegistrationRequest.Builder> startWebAuthnRegistrationRequest)Requests credential creation options from your user pool for registration of a passkey authenticator.default StartWebAuthnRegistrationResponsestartWebAuthnRegistration(StartWebAuthnRegistrationRequest startWebAuthnRegistrationRequest)Requests credential creation options from your user pool for registration of a passkey authenticator.default StopUserImportJobResponsestopUserImportJob(Consumer<StopUserImportJobRequest.Builder> stopUserImportJobRequest)Stops the user import job.default StopUserImportJobResponsestopUserImportJob(StopUserImportJobRequest stopUserImportJobRequest)Stops the user import job.default TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)Assigns a set of tags to an Amazon Cognito user pool.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest)Assigns a set of tags to an Amazon Cognito user pool.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)Removes the specified tags from an Amazon Cognito user pool.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest)Removes the specified tags from an Amazon Cognito user pool.default UpdateAuthEventFeedbackResponseupdateAuthEventFeedback(Consumer<UpdateAuthEventFeedbackRequest.Builder> updateAuthEventFeedbackRequest)Provides the feedback for an authentication event, whether it was from a valid user or not.default UpdateAuthEventFeedbackResponseupdateAuthEventFeedback(UpdateAuthEventFeedbackRequest updateAuthEventFeedbackRequest)Provides the feedback for an authentication event, whether it was from a valid user or not.default UpdateDeviceStatusResponseupdateDeviceStatus(Consumer<UpdateDeviceStatusRequest.Builder> updateDeviceStatusRequest)Updates the device status.default UpdateDeviceStatusResponseupdateDeviceStatus(UpdateDeviceStatusRequest updateDeviceStatusRequest)Updates the device status.default UpdateGroupResponseupdateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest)Updates the specified group with the specified attributes.default UpdateGroupResponseupdateGroup(UpdateGroupRequest updateGroupRequest)Updates the specified group with the specified attributes.default UpdateIdentityProviderResponseupdateIdentityProvider(Consumer<UpdateIdentityProviderRequest.Builder> updateIdentityProviderRequest)Updates IdP information for a user pool.default UpdateIdentityProviderResponseupdateIdentityProvider(UpdateIdentityProviderRequest updateIdentityProviderRequest)Updates IdP information for a user pool.default UpdateManagedLoginBrandingResponseupdateManagedLoginBranding(Consumer<UpdateManagedLoginBrandingRequest.Builder> updateManagedLoginBrandingRequest)Configures the branding settings for a user pool style.default UpdateManagedLoginBrandingResponseupdateManagedLoginBranding(UpdateManagedLoginBrandingRequest updateManagedLoginBrandingRequest)Configures the branding settings for a user pool style.default UpdateResourceServerResponseupdateResourceServer(Consumer<UpdateResourceServerRequest.Builder> updateResourceServerRequest)Updates the name and scopes of resource server.default UpdateResourceServerResponseupdateResourceServer(UpdateResourceServerRequest updateResourceServerRequest)Updates the name and scopes of resource server.default UpdateUserAttributesResponseupdateUserAttributes(Consumer<UpdateUserAttributesRequest.Builder> updateUserAttributesRequest)With this operation, your users can update one or more of their attributes with their own credentials.default UpdateUserAttributesResponseupdateUserAttributes(UpdateUserAttributesRequest updateUserAttributesRequest)With this operation, your users can update one or more of their attributes with their own credentials.default UpdateUserPoolResponseupdateUserPool(Consumer<UpdateUserPoolRequest.Builder> updateUserPoolRequest)default UpdateUserPoolResponseupdateUserPool(UpdateUserPoolRequest updateUserPoolRequest)default UpdateUserPoolClientResponseupdateUserPoolClient(Consumer<UpdateUserPoolClientRequest.Builder> updateUserPoolClientRequest)Updates the specified user pool app client with the specified attributes.default UpdateUserPoolClientResponseupdateUserPoolClient(UpdateUserPoolClientRequest updateUserPoolClientRequest)Updates the specified user pool app client with the specified attributes.default UpdateUserPoolDomainResponseupdateUserPoolDomain(Consumer<UpdateUserPoolDomainRequest.Builder> updateUserPoolDomainRequest)A user pool domain hosts managed login, an authorization server and web server for authentication in your application.default UpdateUserPoolDomainResponseupdateUserPoolDomain(UpdateUserPoolDomainRequest updateUserPoolDomainRequest)A user pool domain hosts managed login, an authorization server and web server for authentication in your application.default VerifySoftwareTokenResponseverifySoftwareToken(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 VerifySoftwareTokenResponseverifySoftwareToken(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 VerifyUserAttributeResponseverifyUserAttribute(Consumer<VerifyUserAttributeRequest.Builder> verifyUserAttributeRequest)Verifies the specified user attributes in the user pool.default VerifyUserAttributeResponseverifyUserAttribute(VerifyUserAttributeRequest verifyUserAttributeRequest)Verifies the specified user attributes in the user pool.-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
addCustomAttributes
default AddCustomAttributesResponse addCustomAttributes(AddCustomAttributesRequest addCustomAttributesRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserImportInProgressException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Adds additional user attributes to the user pool schema. Custom attributes can be mutable or immutable and have a
custom:ordev:prefix. For more information, see Custom attributes.You can also create custom attributes in the Schema parameter of
CreateUserPoolandUpdateUserPool. You can't delete custom attributes after you create them.Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
addCustomAttributesRequest- Represents the request to add custom attributes.- Returns:
- Result of the AddCustomAttributes operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
addCustomAttributes
default AddCustomAttributesResponse addCustomAttributes(Consumer<AddCustomAttributesRequest.Builder> addCustomAttributesRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserImportInProgressException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Adds additional user attributes to the user pool schema. Custom attributes can be mutable or immutable and have a
custom:ordev:prefix. For more information, see Custom attributes.You can also create custom attributes in the Schema parameter of
CreateUserPoolandUpdateUserPool. You can't delete custom attributes after you create them.Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
AddCustomAttributesRequest.Builderavoiding the need to create one manually viaAddCustomAttributesRequest.builder()- Parameters:
addCustomAttributesRequest- AConsumerthat will call methods onAddCustomAttributesRequest.Builderto create a request. Represents the request to add custom attributes.- Returns:
- Result of the AddCustomAttributes operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminAddUserToGroup
default AdminAddUserToGroupResponse adminAddUserToGroup(AdminAddUserToGroupRequest adminAddUserToGroupRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Adds a user to a group. A user who is in a group can present a preferred-role claim to an identity pool, and populates a
cognito:groupsclaim to their access and identity tokens.Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
adminAddUserToGroupRequest-- Returns:
- Result of the AdminAddUserToGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminAddUserToGroup
default AdminAddUserToGroupResponse adminAddUserToGroup(Consumer<AdminAddUserToGroupRequest.Builder> adminAddUserToGroupRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Adds a user to a group. A user who is in a group can present a preferred-role claim to an identity pool, and populates a
cognito:groupsclaim to their access and identity tokens.Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
AdminAddUserToGroupRequest.Builderavoiding the need to create one manually viaAdminAddUserToGroupRequest.builder()- Parameters:
adminAddUserToGroupRequest- AConsumerthat will call methods onAdminAddUserToGroupRequest.Builderto create a request.- Returns:
- Result of the AdminAddUserToGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminConfirmSignUp
default AdminConfirmSignUpResponse adminConfirmSignUp(AdminConfirmSignUpRequest adminConfirmSignUpRequest) throws ResourceNotFoundException, InvalidParameterException, UnexpectedLambdaException, UserLambdaValidationException, NotAuthorizedException, TooManyFailedAttemptsException, InvalidLambdaResponseException, TooManyRequestsException, LimitExceededException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Confirms user sign-up as an administrator. Unlike ConfirmSignUp, your IAM credentials authorize user account confirmation. No confirmation code is required.
This request sets a user account active in a user pool that requires confirmation of new user accounts before they can sign in. You can configure your user pool to not send confirmation codes to new users and instead confirm them with this API operation on the back end.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
To configure your user pool to require administrative confirmation of users, set
AllowAdminCreateUserOnlytotruein aCreateUserPoolorUpdateUserPoolrequest.- Parameters:
adminConfirmSignUpRequest- Confirm a user's registration as a user pool administrator.- Returns:
- Result of the AdminConfirmSignUp operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminConfirmSignUp
default AdminConfirmSignUpResponse adminConfirmSignUp(Consumer<AdminConfirmSignUpRequest.Builder> adminConfirmSignUpRequest) throws ResourceNotFoundException, InvalidParameterException, UnexpectedLambdaException, UserLambdaValidationException, NotAuthorizedException, TooManyFailedAttemptsException, InvalidLambdaResponseException, TooManyRequestsException, LimitExceededException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Confirms user sign-up as an administrator. Unlike ConfirmSignUp, your IAM credentials authorize user account confirmation. No confirmation code is required.
This request sets a user account active in a user pool that requires confirmation of new user accounts before they can sign in. You can configure your user pool to not send confirmation codes to new users and instead confirm them with this API operation on the back end.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
To configure your user pool to require administrative confirmation of users, set
AllowAdminCreateUserOnlytotruein aCreateUserPoolorUpdateUserPoolrequest.
This is a convenience which creates an instance of the
AdminConfirmSignUpRequest.Builderavoiding the need to create one manually viaAdminConfirmSignUpRequest.builder()- Parameters:
adminConfirmSignUpRequest- AConsumerthat will call methods onAdminConfirmSignUpRequest.Builderto create a request. Confirm a user's registration as a user pool administrator.- Returns:
- Result of the AdminConfirmSignUp operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminCreateUser
default AdminCreateUserResponse adminCreateUser(AdminCreateUserRequest adminCreateUserRequest) throws ResourceNotFoundException, InvalidParameterException, UserNotFoundException, UsernameExistsException, InvalidPasswordException, CodeDeliveryFailureException, UnexpectedLambdaException, UserLambdaValidationException, InvalidLambdaResponseException, PreconditionNotMetException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, TooManyRequestsException, NotAuthorizedException, UnsupportedUserStateException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Creates a new user in the specified user pool.
If
MessageActionisn'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 Services 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
AdminCreateUserwithSUPPRESSfor theMessageActionparameter, and Amazon Cognito won't send any email.In either case, if the user has a password, they will be in the
FORCE_CHANGE_PASSWORDstate until they sign in and set their password. Your invitation message template must have the{####}password placeholder if your users have passwords. If your template doesn't have this placeholder, Amazon Cognito doesn't deliver the invitation message. In this case, you must update your message template and resend the password with a newAdminCreateUserrequest with aMessageActionvalue ofRESEND.Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
adminCreateUserRequest- Creates a new user in the specified user pool.- Returns:
- Result of the AdminCreateUser operation returned by the service.
- Throws:
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 trustcognito-idp.amazonaws.comor 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.AwsServiceException- See Also:
- AWS API Documentation
-
adminCreateUser
default AdminCreateUserResponse adminCreateUser(Consumer<AdminCreateUserRequest.Builder> adminCreateUserRequest) throws ResourceNotFoundException, InvalidParameterException, UserNotFoundException, UsernameExistsException, InvalidPasswordException, CodeDeliveryFailureException, UnexpectedLambdaException, UserLambdaValidationException, InvalidLambdaResponseException, PreconditionNotMetException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, TooManyRequestsException, NotAuthorizedException, UnsupportedUserStateException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Creates a new user in the specified user pool.
If
MessageActionisn'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 Services 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
AdminCreateUserwithSUPPRESSfor theMessageActionparameter, and Amazon Cognito won't send any email.In either case, if the user has a password, they will be in the
FORCE_CHANGE_PASSWORDstate until they sign in and set their password. Your invitation message template must have the{####}password placeholder if your users have passwords. If your template doesn't have this placeholder, Amazon Cognito doesn't deliver the invitation message. In this case, you must update your message template and resend the password with a newAdminCreateUserrequest with aMessageActionvalue ofRESEND.Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
AdminCreateUserRequest.Builderavoiding the need to create one manually viaAdminCreateUserRequest.builder()- Parameters:
adminCreateUserRequest- AConsumerthat will call methods onAdminCreateUserRequest.Builderto create a request. Creates a new user in the specified user pool.- Returns:
- Result of the AdminCreateUser operation returned by the service.
- Throws:
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 trustcognito-idp.amazonaws.comor 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.AwsServiceException- See Also:
- AWS API Documentation
-
adminDeleteUser
default AdminDeleteUserResponse adminDeleteUser(AdminDeleteUserRequest adminDeleteUserRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Deletes a user profile in your user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
adminDeleteUserRequest- Represents the request to delete a user as an administrator.- Returns:
- Result of the AdminDeleteUser operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminDeleteUser
default AdminDeleteUserResponse adminDeleteUser(Consumer<AdminDeleteUserRequest.Builder> adminDeleteUserRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Deletes a user profile in your user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
AdminDeleteUserRequest.Builderavoiding the need to create one manually viaAdminDeleteUserRequest.builder()- Parameters:
adminDeleteUserRequest- AConsumerthat will call methods onAdminDeleteUserRequest.Builderto create a request. Represents the request to delete a user as an administrator.- Returns:
- Result of the AdminDeleteUser operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminDeleteUserAttributes
default AdminDeleteUserAttributesResponse adminDeleteUserAttributes(AdminDeleteUserAttributesRequest adminDeleteUserAttributesRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Deletes attribute values from a user. This operation doesn't affect tokens for existing user sessions. The next ID token that the user receives will no longer have this attribute.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
adminDeleteUserAttributesRequest- Represents the request to delete user attributes as an administrator.- Returns:
- Result of the AdminDeleteUserAttributes operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminDeleteUserAttributes
default AdminDeleteUserAttributesResponse adminDeleteUserAttributes(Consumer<AdminDeleteUserAttributesRequest.Builder> adminDeleteUserAttributesRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Deletes attribute values from a user. This operation doesn't affect tokens for existing user sessions. The next ID token that the user receives will no longer have this attribute.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
AdminDeleteUserAttributesRequest.Builderavoiding the need to create one manually viaAdminDeleteUserAttributesRequest.builder()- Parameters:
adminDeleteUserAttributesRequest- AConsumerthat will call methods onAdminDeleteUserAttributesRequest.Builderto create a request. Represents the request to delete user attributes as an administrator.- Returns:
- Result of the AdminDeleteUserAttributes operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminDisableProviderForUser
default 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.The
ProviderNamemust match the value specified when creating an IdP for the pool.To deactivate a native username + password user, the
ProviderNamevalue must beCognitoand theProviderAttributeNamemust beCognito_Subject. TheProviderAttributeValuemust be the name that is used in the user pool for the user.The
ProviderAttributeNamemust always beCognito_Subjectfor social IdPs. TheProviderAttributeValuemust 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
ProviderAttributeNameandProviderAttributeValuemust be the same values that were used for theSourceUserwhen the identities were originally linked usingAdminLinkProviderForUsercall. (If the linking was done withProviderAttributeNameset toCognito_Subject, the same applies here). However, if the user has already signed in, theProviderAttributeNamemust beCognito_SubjectandProviderAttributeValuemust be the subject of the SAML assertion.Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
adminDisableProviderForUserRequest-- Returns:
- Result of the AdminDisableProviderForUser operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminDisableProviderForUser
default 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.The
ProviderNamemust match the value specified when creating an IdP for the pool.To deactivate a native username + password user, the
ProviderNamevalue must beCognitoand theProviderAttributeNamemust beCognito_Subject. TheProviderAttributeValuemust be the name that is used in the user pool for the user.The
ProviderAttributeNamemust always beCognito_Subjectfor social IdPs. TheProviderAttributeValuemust 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
ProviderAttributeNameandProviderAttributeValuemust be the same values that were used for theSourceUserwhen the identities were originally linked usingAdminLinkProviderForUsercall. (If the linking was done withProviderAttributeNameset toCognito_Subject, the same applies here). However, if the user has already signed in, theProviderAttributeNamemust beCognito_SubjectandProviderAttributeValuemust be the subject of the SAML assertion.Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
AdminDisableProviderForUserRequest.Builderavoiding the need to create one manually viaAdminDisableProviderForUserRequest.builder()- Parameters:
adminDisableProviderForUserRequest- AConsumerthat will call methods onAdminDisableProviderForUserRequest.Builderto create a request.- Returns:
- Result of the AdminDisableProviderForUser operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminDisableUser
default AdminDisableUserResponse adminDisableUser(AdminDisableUserRequest adminDisableUserRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Deactivates a user profile and revokes all access tokens for the user. A deactivated user can't sign in, but still appears in the responses to
ListUsersAPI requests.Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
adminDisableUserRequest- Represents the request to disable the user as an administrator.- Returns:
- Result of the AdminDisableUser operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminDisableUser
default AdminDisableUserResponse adminDisableUser(Consumer<AdminDisableUserRequest.Builder> adminDisableUserRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Deactivates a user profile and revokes all access tokens for the user. A deactivated user can't sign in, but still appears in the responses to
ListUsersAPI requests.Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
AdminDisableUserRequest.Builderavoiding the need to create one manually viaAdminDisableUserRequest.builder()- Parameters:
adminDisableUserRequest- AConsumerthat will call methods onAdminDisableUserRequest.Builderto create a request. Represents the request to disable the user as an administrator.- Returns:
- Result of the AdminDisableUser operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminEnableUser
default AdminEnableUserResponse adminEnableUser(AdminEnableUserRequest adminEnableUserRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Activate sign-in for a user profile that previously had sign-in access disabled.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
adminEnableUserRequest- Represents the request that enables the user as an administrator.- Returns:
- Result of the AdminEnableUser operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminEnableUser
default AdminEnableUserResponse adminEnableUser(Consumer<AdminEnableUserRequest.Builder> adminEnableUserRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Activate sign-in for a user profile that previously had sign-in access disabled.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
AdminEnableUserRequest.Builderavoiding the need to create one manually viaAdminEnableUserRequest.builder()- Parameters:
adminEnableUserRequest- AConsumerthat will call methods onAdminEnableUserRequest.Builderto create a request. Represents the request that enables the user as an administrator.- Returns:
- Result of the AdminEnableUser operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminForgetDevice
default AdminForgetDeviceResponse adminForgetDevice(AdminForgetDeviceRequest adminForgetDeviceRequest) throws ResourceNotFoundException, InvalidParameterException, InvalidUserPoolConfigurationException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Forgets, or deletes, a remembered device from a user's profile. After you forget the device, the user can no longer complete device authentication with that device and when applicable, must submit MFA codes again. For more information, see Working with devices.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
adminForgetDeviceRequest- Sends the forgot device request, as an administrator.- Returns:
- Result of the AdminForgetDevice operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminForgetDevice
default AdminForgetDeviceResponse adminForgetDevice(Consumer<AdminForgetDeviceRequest.Builder> adminForgetDeviceRequest) throws ResourceNotFoundException, InvalidParameterException, InvalidUserPoolConfigurationException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Forgets, or deletes, a remembered device from a user's profile. After you forget the device, the user can no longer complete device authentication with that device and when applicable, must submit MFA codes again. For more information, see Working with devices.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
AdminForgetDeviceRequest.Builderavoiding the need to create one manually viaAdminForgetDeviceRequest.builder()- Parameters:
adminForgetDeviceRequest- AConsumerthat will call methods onAdminForgetDeviceRequest.Builderto create a request. Sends the forgot device request, as an administrator.- Returns:
- Result of the AdminForgetDevice operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminGetDevice
default AdminGetDeviceResponse adminGetDevice(AdminGetDeviceRequest adminGetDeviceRequest) throws ResourceNotFoundException, InvalidParameterException, InvalidUserPoolConfigurationException, TooManyRequestsException, InternalErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Given the device key, returns details for a user' device. For more information, see Working with devices.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
adminGetDeviceRequest- Represents the request to get the device, as an administrator.- Returns:
- Result of the AdminGetDevice operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminGetDevice
default AdminGetDeviceResponse adminGetDevice(Consumer<AdminGetDeviceRequest.Builder> adminGetDeviceRequest) throws ResourceNotFoundException, InvalidParameterException, InvalidUserPoolConfigurationException, TooManyRequestsException, InternalErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Given the device key, returns details for a user' device. For more information, see Working with devices.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
AdminGetDeviceRequest.Builderavoiding the need to create one manually viaAdminGetDeviceRequest.builder()- Parameters:
adminGetDeviceRequest- AConsumerthat will call methods onAdminGetDeviceRequest.Builderto create a request. Represents the request to get the device, as an administrator.- Returns:
- Result of the AdminGetDevice operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminGetUser
default AdminGetUserResponse adminGetUser(AdminGetUserRequest adminGetUserRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Given the username, returns details about a user profile in a user pool. This operation contributes to your monthly active user (MAU) count for the purpose of billing. You can specify alias attributes in the
Usernameparameter.Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
adminGetUserRequest- Represents the request to get the specified user as an administrator.- Returns:
- Result of the AdminGetUser operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminGetUser
default AdminGetUserResponse adminGetUser(Consumer<AdminGetUserRequest.Builder> adminGetUserRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Given the username, returns details about a user profile in a user pool. This operation contributes to your monthly active user (MAU) count for the purpose of billing. You can specify alias attributes in the
Usernameparameter.Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
AdminGetUserRequest.Builderavoiding the need to create one manually viaAdminGetUserRequest.builder()- Parameters:
adminGetUserRequest- AConsumerthat will call methods onAdminGetUserRequest.Builderto create a request. Represents the request to get the specified user as an administrator.- Returns:
- Result of the AdminGetUser operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminInitiateAuth
default AdminInitiateAuthResponse adminInitiateAuth(AdminInitiateAuthRequest adminInitiateAuthRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, UnexpectedLambdaException, InvalidUserPoolConfigurationException, UserLambdaValidationException, InvalidLambdaResponseException, MfaMethodNotFoundException, InvalidSmsRoleAccessPolicyException, InvalidEmailRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Starts sign-in for applications with a server-side component, for example a traditional web application. This operation specifies the authentication flow that you'd like to begin. The authentication flow that you specify must be supported in your app client configuration. For more information about authentication flows, see Authentication flows.
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 Services 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.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
adminInitiateAuthRequest- Initiates the authorization request, as an administrator.- Returns:
- Result of the AdminInitiateAuth operation returned by the service.
- Throws:
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.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 trustcognito-idp.amazonaws.comor 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.AwsServiceException- See Also:
- AWS API Documentation
-
adminInitiateAuth
default AdminInitiateAuthResponse adminInitiateAuth(Consumer<AdminInitiateAuthRequest.Builder> adminInitiateAuthRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, UnexpectedLambdaException, InvalidUserPoolConfigurationException, UserLambdaValidationException, InvalidLambdaResponseException, MfaMethodNotFoundException, InvalidSmsRoleAccessPolicyException, InvalidEmailRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Starts sign-in for applications with a server-side component, for example a traditional web application. This operation specifies the authentication flow that you'd like to begin. The authentication flow that you specify must be supported in your app client configuration. For more information about authentication flows, see Authentication flows.
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 Services 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.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
AdminInitiateAuthRequest.Builderavoiding the need to create one manually viaAdminInitiateAuthRequest.builder()- Parameters:
adminInitiateAuthRequest- AConsumerthat will call methods onAdminInitiateAuthRequest.Builderto create a request. Initiates the authorization request, as an administrator.- Returns:
- Result of the AdminInitiateAuth operation returned by the service.
- Throws:
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.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 trustcognito-idp.amazonaws.comor 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.AwsServiceException- See Also:
- AWS API Documentation
-
adminLinkProviderForUser
default AdminLinkProviderForUserResponse adminLinkProviderForUser(AdminLinkProviderForUserRequest adminLinkProviderForUserRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, AliasExistsException, LimitExceededException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Links an existing user account in a user pool (
DestinationUser) to an identity from an external 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.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
adminLinkProviderForUserRequest-- Returns:
- Result of the AdminLinkProviderForUser operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminLinkProviderForUser
default AdminLinkProviderForUserResponse adminLinkProviderForUser(Consumer<AdminLinkProviderForUserRequest.Builder> adminLinkProviderForUserRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, AliasExistsException, LimitExceededException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Links an existing user account in a user pool (
DestinationUser) to an identity from an external 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.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
AdminLinkProviderForUserRequest.Builderavoiding the need to create one manually viaAdminLinkProviderForUserRequest.builder()- Parameters:
adminLinkProviderForUserRequest- AConsumerthat will call methods onAdminLinkProviderForUserRequest.Builderto create a request.- Returns:
- Result of the AdminLinkProviderForUser operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminListDevices
default AdminListDevicesResponse adminListDevices(AdminListDevicesRequest adminListDevicesRequest) throws InvalidParameterException, ResourceNotFoundException, InvalidUserPoolConfigurationException, TooManyRequestsException, InternalErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists a user's registered devices. Remembered devices are used in authentication services where you offer a "Remember me" option for users who you want to permit to sign in without MFA from a trusted device. Users can bypass MFA while your application performs device SRP authentication on the back end. For more information, see Working with devices.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
adminListDevicesRequest- Represents the request to list devices, as an administrator.- Returns:
- Result of the AdminListDevices operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminListDevices
default AdminListDevicesResponse adminListDevices(Consumer<AdminListDevicesRequest.Builder> adminListDevicesRequest) throws InvalidParameterException, ResourceNotFoundException, InvalidUserPoolConfigurationException, TooManyRequestsException, InternalErrorException, NotAuthorizedException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists a user's registered devices. Remembered devices are used in authentication services where you offer a "Remember me" option for users who you want to permit to sign in without MFA from a trusted device. Users can bypass MFA while your application performs device SRP authentication on the back end. For more information, see Working with devices.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
AdminListDevicesRequest.Builderavoiding the need to create one manually viaAdminListDevicesRequest.builder()- Parameters:
adminListDevicesRequest- AConsumerthat will call methods onAdminListDevicesRequest.Builderto create a request. Represents the request to list devices, as an administrator.- Returns:
- Result of the AdminListDevices operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminListGroupsForUser
default AdminListGroupsForUserResponse adminListGroupsForUser(AdminListGroupsForUserRequest adminListGroupsForUserRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the groups that a user belongs to. User pool groups are identifiers that you can reference from the contents of ID and access tokens, and set preferred IAM roles for identity-pool authentication. For more information, see Adding groups to a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
adminListGroupsForUserRequest-- Returns:
- Result of the AdminListGroupsForUser operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminListGroupsForUser
default AdminListGroupsForUserResponse adminListGroupsForUser(Consumer<AdminListGroupsForUserRequest.Builder> adminListGroupsForUserRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the groups that a user belongs to. User pool groups are identifiers that you can reference from the contents of ID and access tokens, and set preferred IAM roles for identity-pool authentication. For more information, see Adding groups to a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
AdminListGroupsForUserRequest.Builderavoiding the need to create one manually viaAdminListGroupsForUserRequest.builder()- Parameters:
adminListGroupsForUserRequest- AConsumerthat will call methods onAdminListGroupsForUserRequest.Builderto create a request.- Returns:
- Result of the AdminListGroupsForUser operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminListGroupsForUserPaginator
default AdminListGroupsForUserIterable adminListGroupsForUserPaginator(AdminListGroupsForUserRequest adminListGroupsForUserRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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
2) Using For loopsoftware.amazon.awssdk.services.cognitoidentityprovider.paginators.AdminListGroupsForUserIterable responses = client.adminListGroupsForUserPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
adminListGroupsForUserRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminListGroupsForUserPaginator
default AdminListGroupsForUserIterable adminListGroupsForUserPaginator(Consumer<AdminListGroupsForUserRequest.Builder> adminListGroupsForUserRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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
2) Using For loopsoftware.amazon.awssdk.services.cognitoidentityprovider.paginators.AdminListGroupsForUserIterable responses = client.adminListGroupsForUserPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaAdminListGroupsForUserRequest.builder()- Parameters:
adminListGroupsForUserRequest- AConsumerthat will call methods onAdminListGroupsForUserRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminListUserAuthEvents
default AdminListUserAuthEventsResponse adminListUserAuthEvents(AdminListUserAuthEventsRequest adminListUserAuthEventsRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, UserPoolAddOnNotEnabledException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Requests a history of user activity and any risks detected as part of Amazon Cognito threat protection. For more information, see Viewing user event history.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
adminListUserAuthEventsRequest-- Returns:
- Result of the AdminListUserAuthEvents operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminListUserAuthEvents
default AdminListUserAuthEventsResponse adminListUserAuthEvents(Consumer<AdminListUserAuthEventsRequest.Builder> adminListUserAuthEventsRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, UserPoolAddOnNotEnabledException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Requests a history of user activity and any risks detected as part of Amazon Cognito threat protection. For more information, see Viewing user event history.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
AdminListUserAuthEventsRequest.Builderavoiding the need to create one manually viaAdminListUserAuthEventsRequest.builder()- Parameters:
adminListUserAuthEventsRequest- AConsumerthat will call methods onAdminListUserAuthEventsRequest.Builderto create a request.- Returns:
- Result of the AdminListUserAuthEvents operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminListUserAuthEventsPaginator
default AdminListUserAuthEventsIterable adminListUserAuthEventsPaginator(AdminListUserAuthEventsRequest adminListUserAuthEventsRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, UserPoolAddOnNotEnabledException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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
2) Using For loopsoftware.amazon.awssdk.services.cognitoidentityprovider.paginators.AdminListUserAuthEventsIterable responses = client.adminListUserAuthEventsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
adminListUserAuthEventsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminListUserAuthEventsPaginator
default AdminListUserAuthEventsIterable adminListUserAuthEventsPaginator(Consumer<AdminListUserAuthEventsRequest.Builder> adminListUserAuthEventsRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, UserPoolAddOnNotEnabledException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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
2) Using For loopsoftware.amazon.awssdk.services.cognitoidentityprovider.paginators.AdminListUserAuthEventsIterable responses = client.adminListUserAuthEventsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaAdminListUserAuthEventsRequest.builder()- Parameters:
adminListUserAuthEventsRequest- AConsumerthat will call methods onAdminListUserAuthEventsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminRemoveUserFromGroup
default AdminRemoveUserFromGroupResponse adminRemoveUserFromGroup(AdminRemoveUserFromGroupRequest adminRemoveUserFromGroupRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Given a username and a group name. removes them from the group. User pool groups are identifiers that you can reference from the contents of ID and access tokens, and set preferred IAM roles for identity-pool authentication. For more information, see Adding groups to a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
adminRemoveUserFromGroupRequest-- Returns:
- Result of the AdminRemoveUserFromGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminRemoveUserFromGroup
default AdminRemoveUserFromGroupResponse adminRemoveUserFromGroup(Consumer<AdminRemoveUserFromGroupRequest.Builder> adminRemoveUserFromGroupRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Given a username and a group name. removes them from the group. User pool groups are identifiers that you can reference from the contents of ID and access tokens, and set preferred IAM roles for identity-pool authentication. For more information, see Adding groups to a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
AdminRemoveUserFromGroupRequest.Builderavoiding the need to create one manually viaAdminRemoveUserFromGroupRequest.builder()- Parameters:
adminRemoveUserFromGroupRequest- AConsumerthat will call methods onAdminRemoveUserFromGroupRequest.Builderto create a request.- Returns:
- Result of the AdminRemoveUserFromGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminResetUserPassword
default AdminResetUserPasswordResponse adminResetUserPassword(AdminResetUserPasswordRequest adminResetUserPasswordRequest) throws ResourceNotFoundException, InvalidParameterException, UnexpectedLambdaException, UserLambdaValidationException, NotAuthorizedException, InvalidLambdaResponseException, TooManyRequestsException, LimitExceededException, UserNotFoundException, InvalidSmsRoleAccessPolicyException, InvalidEmailRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Resets the specified user's password in a user pool. This operation doesn't change the user's password, but sends a password-reset code. This operation is the administrative authentication API equivalent to ForgotPassword.
This operation deactivates a user's password, requiring them to change it. If a user tries to sign in after the API request, Amazon Cognito responds with a
PasswordResetRequiredExceptionerror. Your app must then complete the forgot-password flow by prompting the user for their code and a new password, then submitting those values in a ConfirmForgotPassword request. 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.To use this API operation, your user pool must have self-service account recovery configured. Use AdminSetUserPassword if you manage passwords 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 Services 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.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
adminResetUserPasswordRequest- Represents the request to reset a user's password as an administrator.- Returns:
- Result of the AdminResetUserPassword operation returned by the service.
- Throws:
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 trustcognito-idp.amazonaws.comor the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.InternalErrorException- This exception is thrown when Amazon Cognito encounters an internal error.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
adminResetUserPassword
default AdminResetUserPasswordResponse adminResetUserPassword(Consumer<AdminResetUserPasswordRequest.Builder> adminResetUserPasswordRequest) throws ResourceNotFoundException, InvalidParameterException, UnexpectedLambdaException, UserLambdaValidationException, NotAuthorizedException, InvalidLambdaResponseException, TooManyRequestsException, LimitExceededException, UserNotFoundException, InvalidSmsRoleAccessPolicyException, InvalidEmailRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Resets the specified user's password in a user pool. This operation doesn't change the user's password, but sends a password-reset code. This operation is the administrative authentication API equivalent to ForgotPassword.
This operation deactivates a user's password, requiring them to change it. If a user tries to sign in after the API request, Amazon Cognito responds with a
PasswordResetRequiredExceptionerror. Your app must then complete the forgot-password flow by prompting the user for their code and a new password, then submitting those values in a ConfirmForgotPassword request. 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.To use this API operation, your user pool must have self-service account recovery configured. Use AdminSetUserPassword if you manage passwords 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 Services 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.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
AdminResetUserPasswordRequest.Builderavoiding the need to create one manually viaAdminResetUserPasswordRequest.builder()- Parameters:
adminResetUserPasswordRequest- AConsumerthat will call methods onAdminResetUserPasswordRequest.Builderto create a request. Represents the request to reset a user's password as an administrator.- Returns:
- Result of the AdminResetUserPassword operation returned by the service.
- Throws:
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 trustcognito-idp.amazonaws.comor the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.InternalErrorException- This exception is thrown when Amazon Cognito encounters an internal error.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
adminRespondToAuthChallenge
default AdminRespondToAuthChallengeResponse adminRespondToAuthChallenge(AdminRespondToAuthChallengeRequest adminRespondToAuthChallengeRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, CodeMismatchException, ExpiredCodeException, UnexpectedLambdaException, InvalidPasswordException, PasswordHistoryPolicyViolationException, UserLambdaValidationException, InvalidLambdaResponseException, TooManyRequestsException, InvalidUserPoolConfigurationException, InternalErrorException, MfaMethodNotFoundException, InvalidEmailRoleAccessPolicyException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, AliasExistsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, SoftwareTokenMfaNotFoundException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Some API operations in a user pool generate a challenge, like a prompt for an MFA code, for device authentication that bypasses MFA, or for a custom authentication challenge. An
AdminRespondToAuthChallengeAPI request provides the answer to that challenge, like a code or a secure remote password (SRP). The parameters of a response to an authentication challenge vary with the type of challenge.For more information about custom authentication challenges, see Custom authentication challenge Lambda triggers.
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 Services 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.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
adminRespondToAuthChallengeRequest- The request to respond to the authentication challenge, as an administrator.- Returns:
- Result of the AdminRespondToAuthChallenge operation returned by the service.
- Throws:
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.PasswordHistoryPolicyViolationException- The message returned when a user's new password matches a previous password and doesn't comply with the password-history policy.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.InvalidEmailRoleAccessPolicyException- This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP status code: 400.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 trustcognito-idp.amazonaws.comor 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.AwsServiceException- See Also:
- AWS API Documentation
-
adminRespondToAuthChallenge
default AdminRespondToAuthChallengeResponse adminRespondToAuthChallenge(Consumer<AdminRespondToAuthChallengeRequest.Builder> adminRespondToAuthChallengeRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, CodeMismatchException, ExpiredCodeException, UnexpectedLambdaException, InvalidPasswordException, PasswordHistoryPolicyViolationException, UserLambdaValidationException, InvalidLambdaResponseException, TooManyRequestsException, InvalidUserPoolConfigurationException, InternalErrorException, MfaMethodNotFoundException, InvalidEmailRoleAccessPolicyException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, AliasExistsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, SoftwareTokenMfaNotFoundException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Some API operations in a user pool generate a challenge, like a prompt for an MFA code, for device authentication that bypasses MFA, or for a custom authentication challenge. An
AdminRespondToAuthChallengeAPI request provides the answer to that challenge, like a code or a secure remote password (SRP). The parameters of a response to an authentication challenge vary with the type of challenge.For more information about custom authentication challenges, see Custom authentication challenge Lambda triggers.
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 Services 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.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
AdminRespondToAuthChallengeRequest.Builderavoiding the need to create one manually viaAdminRespondToAuthChallengeRequest.builder()- Parameters:
adminRespondToAuthChallengeRequest- AConsumerthat will call methods onAdminRespondToAuthChallengeRequest.Builderto create a request. The request to respond to the authentication challenge, as an administrator.- Returns:
- Result of the AdminRespondToAuthChallenge operation returned by the service.
- Throws:
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.PasswordHistoryPolicyViolationException- The message returned when a user's new password matches a previous password and doesn't comply with the password-history policy.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.InvalidEmailRoleAccessPolicyException- This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP status code: 400.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 trustcognito-idp.amazonaws.comor 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.AwsServiceException- See Also:
- AWS API Documentation
-
adminSetUserMFAPreference
default AdminSetUserMfaPreferenceResponse adminSetUserMFAPreference(AdminSetUserMfaPreferenceRequest adminSetUserMfaPreferenceRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Sets the user's multi-factor authentication (MFA) preference, including which MFA options are 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 operation doesn't reset an existing TOTP MFA for a user. To register a new TOTP factor for a user, make an AssociateSoftwareToken request. For more information, see TOTP software token MFA.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
adminSetUserMfaPreferenceRequest-- Returns:
- Result of the AdminSetUserMFAPreference operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminSetUserMFAPreference
default AdminSetUserMfaPreferenceResponse adminSetUserMFAPreference(Consumer<AdminSetUserMfaPreferenceRequest.Builder> adminSetUserMfaPreferenceRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Sets the user's multi-factor authentication (MFA) preference, including which MFA options are 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 operation doesn't reset an existing TOTP MFA for a user. To register a new TOTP factor for a user, make an AssociateSoftwareToken request. For more information, see TOTP software token MFA.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
AdminSetUserMfaPreferenceRequest.Builderavoiding the need to create one manually viaAdminSetUserMfaPreferenceRequest.builder()- Parameters:
adminSetUserMfaPreferenceRequest- AConsumerthat will call methods onAdminSetUserMfaPreferenceRequest.Builderto create a request.- Returns:
- Result of the AdminSetUserMFAPreference operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminSetUserPassword
default AdminSetUserPasswordResponse adminSetUserPassword(AdminSetUserPasswordRequest adminSetUserPasswordRequest) throws ResourceNotFoundException, NotAuthorizedException, UserNotFoundException, InternalErrorException, TooManyRequestsException, InvalidParameterException, InvalidPasswordException, PasswordHistoryPolicyViolationException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Sets the specified user's password in a user pool. This operation administratively sets a temporary or permanent password for a user. With this operation, you can bypass self-service password changes and permit immediate sign-in with the password that you set. To do this, set
Permanenttotrue.You can also set a new temporary password in this request, send it to a user, and require them to choose a new password on their next sign-in. To do this, set
Permanenttofalse.If the password is temporary, the user's
StatusbecomesFORCE_CHANGE_PASSWORD. When the user next tries to sign in, theInitiateAuthorAdminInitiateAuthresponse includes theNEW_PASSWORD_REQUIREDchallenge. If the user doesn't sign in before the temporary password expires, they can no longer sign in and you must repeat this operation to set a temporary or permanent password for them.After the user sets a new password, or if you set a permanent password, their status becomes
Confirmed.AdminSetUserPasswordcan set a password for the user profile that Amazon Cognito creates for third-party federated users. When you set a password, the federated user's status changes fromEXTERNAL_PROVIDERtoCONFIRMED. A user in this state can sign in as a federated user, and initiate authentication flows in the API like a linked native user. They can also modify their password and attributes in token-authenticated API requests likeChangePasswordandUpdateUserAttributes. As a best security practice and to keep users in sync with your external IdP, don't set passwords on federated user profiles. To set up a federated user for native sign-in with a linked native user, refer to Linking federated users to an existing user profile.Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
adminSetUserPasswordRequest-- Returns:
- Result of the AdminSetUserPassword operation returned by the service.
- Throws:
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.PasswordHistoryPolicyViolationException- The message returned when a user's new password matches a previous password and doesn't comply with the password-history policy.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
adminSetUserPassword
default AdminSetUserPasswordResponse adminSetUserPassword(Consumer<AdminSetUserPasswordRequest.Builder> adminSetUserPasswordRequest) throws ResourceNotFoundException, NotAuthorizedException, UserNotFoundException, InternalErrorException, TooManyRequestsException, InvalidParameterException, InvalidPasswordException, PasswordHistoryPolicyViolationException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Sets the specified user's password in a user pool. This operation administratively sets a temporary or permanent password for a user. With this operation, you can bypass self-service password changes and permit immediate sign-in with the password that you set. To do this, set
Permanenttotrue.You can also set a new temporary password in this request, send it to a user, and require them to choose a new password on their next sign-in. To do this, set
Permanenttofalse.If the password is temporary, the user's
StatusbecomesFORCE_CHANGE_PASSWORD. When the user next tries to sign in, theInitiateAuthorAdminInitiateAuthresponse includes theNEW_PASSWORD_REQUIREDchallenge. If the user doesn't sign in before the temporary password expires, they can no longer sign in and you must repeat this operation to set a temporary or permanent password for them.After the user sets a new password, or if you set a permanent password, their status becomes
Confirmed.AdminSetUserPasswordcan set a password for the user profile that Amazon Cognito creates for third-party federated users. When you set a password, the federated user's status changes fromEXTERNAL_PROVIDERtoCONFIRMED. A user in this state can sign in as a federated user, and initiate authentication flows in the API like a linked native user. They can also modify their password and attributes in token-authenticated API requests likeChangePasswordandUpdateUserAttributes. As a best security practice and to keep users in sync with your external IdP, don't set passwords on federated user profiles. To set up a federated user for native sign-in with a linked native user, refer to Linking federated users to an existing user profile.Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
AdminSetUserPasswordRequest.Builderavoiding the need to create one manually viaAdminSetUserPasswordRequest.builder()- Parameters:
adminSetUserPasswordRequest- AConsumerthat will call methods onAdminSetUserPasswordRequest.Builderto create a request.- Returns:
- Result of the AdminSetUserPassword operation returned by the service.
- Throws:
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.PasswordHistoryPolicyViolationException- The message returned when a user's new password matches a previous password and doesn't comply with the password-history policy.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
adminSetUserSettings
default AdminSetUserSettingsResponse adminSetUserSettings(AdminSetUserSettingsRequest adminSetUserSettingsRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software token MFA. To configure either type of MFA, use AdminSetUserMFAPreference instead.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
adminSetUserSettingsRequest- You can use this parameter to set an MFA configuration that uses the SMS delivery medium.- Returns:
- Result of the AdminSetUserSettings operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminSetUserSettings
default AdminSetUserSettingsResponse adminSetUserSettings(Consumer<AdminSetUserSettingsRequest.Builder> adminSetUserSettingsRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software token MFA. To configure either type of MFA, use AdminSetUserMFAPreference instead.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
AdminSetUserSettingsRequest.Builderavoiding the need to create one manually viaAdminSetUserSettingsRequest.builder()- Parameters:
adminSetUserSettingsRequest- AConsumerthat will call methods onAdminSetUserSettingsRequest.Builderto create a request. You can use this parameter to set an MFA configuration that uses the SMS delivery medium.- Returns:
- Result of the AdminSetUserSettings operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminUpdateAuthEventFeedback
default 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 threat protection. To train the threat-protection model to recognize trusted and untrusted sign-in characteristics, configure threat protection in audit-only mode and provide a mechanism for users or administrators to submit feedback. Your feedback can tell Amazon Cognito that a risk rating was assigned at a level you don't agree with.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
adminUpdateAuthEventFeedbackRequest-- Returns:
- Result of the AdminUpdateAuthEventFeedback operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminUpdateAuthEventFeedback
default 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 threat protection. To train the threat-protection model to recognize trusted and untrusted sign-in characteristics, configure threat protection in audit-only mode and provide a mechanism for users or administrators to submit feedback. Your feedback can tell Amazon Cognito that a risk rating was assigned at a level you don't agree with.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
AdminUpdateAuthEventFeedbackRequest.Builderavoiding the need to create one manually viaAdminUpdateAuthEventFeedbackRequest.builder()- Parameters:
adminUpdateAuthEventFeedbackRequest- AConsumerthat will call methods onAdminUpdateAuthEventFeedbackRequest.Builderto create a request.- Returns:
- Result of the AdminUpdateAuthEventFeedback operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminUpdateDeviceStatus
default AdminUpdateDeviceStatusResponse adminUpdateDeviceStatus(AdminUpdateDeviceStatusRequest adminUpdateDeviceStatusRequest) throws InvalidParameterException, ResourceNotFoundException, InvalidUserPoolConfigurationException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Updates the status of a user's device so that it is marked as remembered or not remembered for the purpose of device authentication. Device authentication is a "remember me" mechanism that silently completes sign-in from trusted devices with a device key instead of a user-provided MFA code. This operation changes the status of a device without deleting it, so you can enable it again later. For more information about device authentication, see Working with devices.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
adminUpdateDeviceStatusRequest- The request to update the device status, as an administrator.- Returns:
- Result of the AdminUpdateDeviceStatus operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminUpdateDeviceStatus
default AdminUpdateDeviceStatusResponse adminUpdateDeviceStatus(Consumer<AdminUpdateDeviceStatusRequest.Builder> adminUpdateDeviceStatusRequest) throws InvalidParameterException, ResourceNotFoundException, InvalidUserPoolConfigurationException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Updates the status of a user's device so that it is marked as remembered or not remembered for the purpose of device authentication. Device authentication is a "remember me" mechanism that silently completes sign-in from trusted devices with a device key instead of a user-provided MFA code. This operation changes the status of a device without deleting it, so you can enable it again later. For more information about device authentication, see Working with devices.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
AdminUpdateDeviceStatusRequest.Builderavoiding the need to create one manually viaAdminUpdateDeviceStatusRequest.builder()- Parameters:
adminUpdateDeviceStatusRequest- AConsumerthat will call methods onAdminUpdateDeviceStatusRequest.Builderto create a request. The request to update the device status, as an administrator.- Returns:
- Result of the AdminUpdateDeviceStatus operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
adminUpdateUserAttributes
default AdminUpdateUserAttributesResponse adminUpdateUserAttributes(AdminUpdateUserAttributesRequest adminUpdateUserAttributesRequest) throws ResourceNotFoundException, InvalidParameterException, UnexpectedLambdaException, UserLambdaValidationException, InvalidLambdaResponseException, AliasExistsException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, InvalidSmsRoleAccessPolicyException, InvalidEmailRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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 Services 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.
Updates the specified user's attributes. To delete an attribute from your user, submit the attribute in your API request with a blank value.
For custom attributes, you must prepend the
custom:prefix to the attribute name.This operation can set a user's email address or phone number as verified and permit immediate sign-in in user pools that require verification of these attributes. To do this, set the
email_verifiedorphone_number_verifiedattribute totrue.Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
adminUpdateUserAttributesRequest- Represents the request to update the user's attributes as an administrator.- Returns:
- Result of the AdminUpdateUserAttributes operation returned by the service.
- Throws:
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 trustcognito-idp.amazonaws.comor the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
adminUpdateUserAttributes
default AdminUpdateUserAttributesResponse adminUpdateUserAttributes(Consumer<AdminUpdateUserAttributesRequest.Builder> adminUpdateUserAttributesRequest) throws ResourceNotFoundException, InvalidParameterException, UnexpectedLambdaException, UserLambdaValidationException, InvalidLambdaResponseException, AliasExistsException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, InvalidSmsRoleAccessPolicyException, InvalidEmailRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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 Services 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.
Updates the specified user's attributes. To delete an attribute from your user, submit the attribute in your API request with a blank value.
For custom attributes, you must prepend the
custom:prefix to the attribute name.This operation can set a user's email address or phone number as verified and permit immediate sign-in in user pools that require verification of these attributes. To do this, set the
email_verifiedorphone_number_verifiedattribute totrue.Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
AdminUpdateUserAttributesRequest.Builderavoiding the need to create one manually viaAdminUpdateUserAttributesRequest.builder()- Parameters:
adminUpdateUserAttributesRequest- AConsumerthat will call methods onAdminUpdateUserAttributesRequest.Builderto create a request. Represents the request to update the user's attributes as an administrator.- Returns:
- Result of the AdminUpdateUserAttributes operation returned by the service.
- Throws:
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 trustcognito-idp.amazonaws.comor the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
adminUserGlobalSignOut
default AdminUserGlobalSignOutResponse adminUserGlobalSignOut(AdminUserGlobalSignOutRequest adminUserGlobalSignOutRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Invalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user. Call this operation with your administrative credentials when your user signs out of your app. This results in the following behavior.
-
Amazon Cognito no longer accepts token-authorized user operations that you authorize with a signed-out user's access tokens. For more information, see Using the Amazon Cognito user pools API and user pool endpoints.
Amazon Cognito returns an
Access Token has been revokederror when your app attempts to authorize a user pools API request with a revoked access token that contains the scopeaws.cognito.signin.user.admin. -
Amazon Cognito no longer accepts a signed-out user's ID token in a GetId request to an identity pool with
ServerSideTokenCheckenabled for its user pool IdP configuration in CognitoIdentityProvider. -
Amazon Cognito no longer accepts a signed-out user's refresh tokens in refresh requests.
Other requests might be valid until your user's token expires. This operation doesn't clear the managed login session cookie. To clear the session for a user who signed in with managed login or the classic hosted UI, direct their browser session to the logout endpoint.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
adminUserGlobalSignOutRequest- The request to sign out of all devices, as an administrator.- Returns:
- Result of the AdminUserGlobalSignOut operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
adminUserGlobalSignOut
default AdminUserGlobalSignOutResponse adminUserGlobalSignOut(Consumer<AdminUserGlobalSignOutRequest.Builder> adminUserGlobalSignOutRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Invalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user. Call this operation with your administrative credentials when your user signs out of your app. This results in the following behavior.
-
Amazon Cognito no longer accepts token-authorized user operations that you authorize with a signed-out user's access tokens. For more information, see Using the Amazon Cognito user pools API and user pool endpoints.
Amazon Cognito returns an
Access Token has been revokederror when your app attempts to authorize a user pools API request with a revoked access token that contains the scopeaws.cognito.signin.user.admin. -
Amazon Cognito no longer accepts a signed-out user's ID token in a GetId request to an identity pool with
ServerSideTokenCheckenabled for its user pool IdP configuration in CognitoIdentityProvider. -
Amazon Cognito no longer accepts a signed-out user's refresh tokens in refresh requests.
Other requests might be valid until your user's token expires. This operation doesn't clear the managed login session cookie. To clear the session for a user who signed in with managed login or the classic hosted UI, direct their browser session to the logout endpoint.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
AdminUserGlobalSignOutRequest.Builderavoiding the need to create one manually viaAdminUserGlobalSignOutRequest.builder()- Parameters:
adminUserGlobalSignOutRequest- AConsumerthat will call methods onAdminUserGlobalSignOutRequest.Builderto create a request. The request to sign out of all devices, as an administrator.- Returns:
- Result of the AdminUserGlobalSignOut operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
associateSoftwareToken
default AssociateSoftwareTokenResponse associateSoftwareToken(AssociateSoftwareTokenRequest associateSoftwareTokenRequest) throws ConcurrentModificationException, InvalidParameterException, NotAuthorizedException, ResourceNotFoundException, InternalErrorException, SoftwareTokenMfaNotFoundException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Begins setup of time-based one-time password (TOTP) multi-factor authentication (MFA) for a user, with a unique private key that Amazon Cognito generates and returns in the API response. You can authorize an
AssociateSoftwareTokenrequest 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_SETUPorSOFTWARE_TOKEN_SETUPchallenge each time your user signs in. Complete setup withAssociateSoftwareTokenandVerifySoftwareToken.After you set up software token MFA for your user, Amazon Cognito generates a
SOFTWARE_TOKEN_MFAchallenge when they authenticate. Respond to this challenge with your user's TOTP.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.- Parameters:
associateSoftwareTokenRequest-- Returns:
- Result of the AssociateSoftwareToken operation returned by the service.
- Throws:
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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
associateSoftwareToken
default AssociateSoftwareTokenResponse associateSoftwareToken(Consumer<AssociateSoftwareTokenRequest.Builder> associateSoftwareTokenRequest) throws ConcurrentModificationException, InvalidParameterException, NotAuthorizedException, ResourceNotFoundException, InternalErrorException, SoftwareTokenMfaNotFoundException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Begins setup of time-based one-time password (TOTP) multi-factor authentication (MFA) for a user, with a unique private key that Amazon Cognito generates and returns in the API response. You can authorize an
AssociateSoftwareTokenrequest 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_SETUPorSOFTWARE_TOKEN_SETUPchallenge each time your user signs in. Complete setup withAssociateSoftwareTokenandVerifySoftwareToken.After you set up software token MFA for your user, Amazon Cognito generates a
SOFTWARE_TOKEN_MFAchallenge when they authenticate. Respond to this challenge with your user's TOTP.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.
This is a convenience which creates an instance of the
AssociateSoftwareTokenRequest.Builderavoiding the need to create one manually viaAssociateSoftwareTokenRequest.builder()- Parameters:
associateSoftwareTokenRequest- AConsumerthat will call methods onAssociateSoftwareTokenRequest.Builderto create a request.- Returns:
- Result of the AssociateSoftwareToken operation returned by the service.
- Throws:
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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
changePassword
default ChangePasswordResponse changePassword(ChangePasswordRequest changePasswordRequest) throws ResourceNotFoundException, InvalidParameterException, InvalidPasswordException, PasswordHistoryPolicyViolationException, NotAuthorizedException, TooManyRequestsException, LimitExceededException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Changes the password for a specified user in a user pool.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
- Parameters:
changePasswordRequest- Represents the request to change a user password.- Returns:
- Result of the ChangePassword operation returned by the service.
- Throws:
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.PasswordHistoryPolicyViolationException- The message returned when a user's new password matches a previous password and doesn't comply with the password-history policy.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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
changePassword
default ChangePasswordResponse changePassword(Consumer<ChangePasswordRequest.Builder> changePasswordRequest) throws ResourceNotFoundException, InvalidParameterException, InvalidPasswordException, PasswordHistoryPolicyViolationException, NotAuthorizedException, TooManyRequestsException, LimitExceededException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Changes the password for a specified user in a user pool.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
This is a convenience which creates an instance of the
ChangePasswordRequest.Builderavoiding the need to create one manually viaChangePasswordRequest.builder()- Parameters:
changePasswordRequest- AConsumerthat will call methods onChangePasswordRequest.Builderto create a request. Represents the request to change a user password.- Returns:
- Result of the ChangePassword operation returned by the service.
- Throws:
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.PasswordHistoryPolicyViolationException- The message returned when a user's new password matches a previous password and doesn't comply with the password-history policy.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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
completeWebAuthnRegistration
default CompleteWebAuthnRegistrationResponse completeWebAuthnRegistration(CompleteWebAuthnRegistrationRequest completeWebAuthnRegistrationRequest) throws ForbiddenException, InternalErrorException, InvalidParameterException, LimitExceededException, NotAuthorizedException, TooManyRequestsException, WebAuthnNotEnabledException, WebAuthnChallengeNotFoundException, WebAuthnRelyingPartyMismatchException, WebAuthnClientMismatchException, WebAuthnOriginNotAllowedException, WebAuthnCredentialNotSupportedException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Completes registration of a passkey authenticator for the current user. Your application provides data from a successful registration request with the data from the output of a StartWebAuthnRegistration.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.- Parameters:
completeWebAuthnRegistrationRequest-- Returns:
- Result of the CompleteWebAuthnRegistration operation returned by the service.
- Throws:
ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.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.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.TooManyRequestsException- This exception is thrown when the user has made too many requests for a given operation.WebAuthnNotEnabledException- This exception is thrown when the passkey feature isn't enabled for the user pool.WebAuthnChallengeNotFoundException- This exception is thrown when the challenge fromStartWebAuthnregistration has expired.WebAuthnRelyingPartyMismatchException- This exception is thrown when the given passkey credential is associated with a different relying party ID than the user pool relying party ID.WebAuthnClientMismatchException- This exception is thrown when the access token is for a different client than the one in the originalStartWebAuthnRegistrationrequest.WebAuthnOriginNotAllowedException- This exception is thrown when the passkey credential's registration origin does not align with the user pool relying party id.WebAuthnCredentialNotSupportedException- This exception is thrown when a user presents passkey credentials from an unsupported device or provider.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
completeWebAuthnRegistration
default CompleteWebAuthnRegistrationResponse completeWebAuthnRegistration(Consumer<CompleteWebAuthnRegistrationRequest.Builder> completeWebAuthnRegistrationRequest) throws ForbiddenException, InternalErrorException, InvalidParameterException, LimitExceededException, NotAuthorizedException, TooManyRequestsException, WebAuthnNotEnabledException, WebAuthnChallengeNotFoundException, WebAuthnRelyingPartyMismatchException, WebAuthnClientMismatchException, WebAuthnOriginNotAllowedException, WebAuthnCredentialNotSupportedException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Completes registration of a passkey authenticator for the current user. Your application provides data from a successful registration request with the data from the output of a StartWebAuthnRegistration.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.
This is a convenience which creates an instance of the
CompleteWebAuthnRegistrationRequest.Builderavoiding the need to create one manually viaCompleteWebAuthnRegistrationRequest.builder()- Parameters:
completeWebAuthnRegistrationRequest- AConsumerthat will call methods onCompleteWebAuthnRegistrationRequest.Builderto create a request.- Returns:
- Result of the CompleteWebAuthnRegistration operation returned by the service.
- Throws:
ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.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.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.TooManyRequestsException- This exception is thrown when the user has made too many requests for a given operation.WebAuthnNotEnabledException- This exception is thrown when the passkey feature isn't enabled for the user pool.WebAuthnChallengeNotFoundException- This exception is thrown when the challenge fromStartWebAuthnregistration has expired.WebAuthnRelyingPartyMismatchException- This exception is thrown when the given passkey credential is associated with a different relying party ID than the user pool relying party ID.WebAuthnClientMismatchException- This exception is thrown when the access token is for a different client than the one in the originalStartWebAuthnRegistrationrequest.WebAuthnOriginNotAllowedException- This exception is thrown when the passkey credential's registration origin does not align with the user pool relying party id.WebAuthnCredentialNotSupportedException- This exception is thrown when a user presents passkey credentials from an unsupported device or provider.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
confirmDevice
default ConfirmDeviceResponse confirmDevice(ConfirmDeviceRequest confirmDeviceRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, InvalidPasswordException, InvalidLambdaResponseException, UsernameExistsException, InvalidUserPoolConfigurationException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Confirms a device that a user wants to remember. A remembered device is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see Working with user devices in your user pool.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
- Parameters:
confirmDeviceRequest- The confirm-device request.- Returns:
- Result of the ConfirmDevice operation returned by the service.
- Throws:
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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
confirmDevice
default ConfirmDeviceResponse confirmDevice(Consumer<ConfirmDeviceRequest.Builder> confirmDeviceRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, InvalidPasswordException, InvalidLambdaResponseException, UsernameExistsException, InvalidUserPoolConfigurationException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Confirms a device that a user wants to remember. A remembered device is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see Working with user devices in your user pool.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
This is a convenience which creates an instance of the
ConfirmDeviceRequest.Builderavoiding the need to create one manually viaConfirmDeviceRequest.builder()- Parameters:
confirmDeviceRequest- AConsumerthat will call methods onConfirmDeviceRequest.Builderto create a request. The confirm-device request.- Returns:
- Result of the ConfirmDevice operation returned by the service.
- Throws:
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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
confirmForgotPassword
default ConfirmForgotPasswordResponse confirmForgotPassword(ConfirmForgotPasswordRequest confirmForgotPasswordRequest) throws ResourceNotFoundException, UnexpectedLambdaException, UserLambdaValidationException, InvalidParameterException, InvalidPasswordException, PasswordHistoryPolicyViolationException, NotAuthorizedException, CodeMismatchException, ExpiredCodeException, TooManyFailedAttemptsException, InvalidLambdaResponseException, TooManyRequestsException, LimitExceededException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
This public API operation accepts a confirmation code that Amazon Cognito sent to a user and accepts a new password for that user.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
- Parameters:
confirmForgotPasswordRequest- The request representing the confirmation for a password reset.- Returns:
- Result of the ConfirmForgotPassword operation returned by the service.
- Throws:
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.PasswordHistoryPolicyViolationException- The message returned when a user's new password matches a previous password and doesn't comply with the password-history policy.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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
confirmForgotPassword
default ConfirmForgotPasswordResponse confirmForgotPassword(Consumer<ConfirmForgotPasswordRequest.Builder> confirmForgotPasswordRequest) throws ResourceNotFoundException, UnexpectedLambdaException, UserLambdaValidationException, InvalidParameterException, InvalidPasswordException, PasswordHistoryPolicyViolationException, NotAuthorizedException, CodeMismatchException, ExpiredCodeException, TooManyFailedAttemptsException, InvalidLambdaResponseException, TooManyRequestsException, LimitExceededException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
This public API operation accepts a confirmation code that Amazon Cognito sent to a user and accepts a new password for that user.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
This is a convenience which creates an instance of the
ConfirmForgotPasswordRequest.Builderavoiding the need to create one manually viaConfirmForgotPasswordRequest.builder()- Parameters:
confirmForgotPasswordRequest- AConsumerthat will call methods onConfirmForgotPasswordRequest.Builderto create a request. The request representing the confirmation for a password reset.- Returns:
- Result of the ConfirmForgotPassword operation returned by the service.
- Throws:
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.PasswordHistoryPolicyViolationException- The message returned when a user's new password matches a previous password and doesn't comply with the password-history policy.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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
confirmSignUp
default ConfirmSignUpResponse confirmSignUp(ConfirmSignUpRequest confirmSignUpRequest) throws ResourceNotFoundException, InvalidParameterException, UnexpectedLambdaException, UserLambdaValidationException, NotAuthorizedException, TooManyFailedAttemptsException, CodeMismatchException, ExpiredCodeException, InvalidLambdaResponseException, AliasExistsException, TooManyRequestsException, LimitExceededException, UserNotFoundException, InternalErrorException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
This public API operation submits a code that Amazon Cognito sent to your user when they signed up in your user pool via the SignUp API operation. After your user enters their code, they confirm ownership of the email address or phone number that they provided, and their user account becomes active. Depending on your user pool configuration, your users will receive their confirmation code in an email or SMS message.
Local users who signed up in your user pool are the only type of user who can confirm sign-up with a code. Users who federate through an external identity provider (IdP) have already been confirmed by their IdP. Administrator-created users, users created with the AdminCreateUser API operation, confirm their accounts when they respond to their invitation email message and choose a password. They do not receive a confirmation code. Instead, they receive a temporary password.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
- Parameters:
confirmSignUpRequest- Represents the request to confirm registration of a user.- Returns:
- Result of the ConfirmSignUp operation returned by the service.
- Throws:
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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
confirmSignUp
default ConfirmSignUpResponse confirmSignUp(Consumer<ConfirmSignUpRequest.Builder> confirmSignUpRequest) throws ResourceNotFoundException, InvalidParameterException, UnexpectedLambdaException, UserLambdaValidationException, NotAuthorizedException, TooManyFailedAttemptsException, CodeMismatchException, ExpiredCodeException, InvalidLambdaResponseException, AliasExistsException, TooManyRequestsException, LimitExceededException, UserNotFoundException, InternalErrorException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
This public API operation submits a code that Amazon Cognito sent to your user when they signed up in your user pool via the SignUp API operation. After your user enters their code, they confirm ownership of the email address or phone number that they provided, and their user account becomes active. Depending on your user pool configuration, your users will receive their confirmation code in an email or SMS message.
Local users who signed up in your user pool are the only type of user who can confirm sign-up with a code. Users who federate through an external identity provider (IdP) have already been confirmed by their IdP. Administrator-created users, users created with the AdminCreateUser API operation, confirm their accounts when they respond to their invitation email message and choose a password. They do not receive a confirmation code. Instead, they receive a temporary password.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
This is a convenience which creates an instance of the
ConfirmSignUpRequest.Builderavoiding the need to create one manually viaConfirmSignUpRequest.builder()- Parameters:
confirmSignUpRequest- AConsumerthat will call methods onConfirmSignUpRequest.Builderto create a request. Represents the request to confirm registration of a user.- Returns:
- Result of the ConfirmSignUp operation returned by the service.
- Throws:
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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createGroup
default CreateGroupResponse createGroup(CreateGroupRequest createGroupRequest) throws InvalidParameterException, GroupExistsException, ResourceNotFoundException, TooManyRequestsException, LimitExceededException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Creates a new group in the specified user pool. For more information about user pool groups see Adding groups to a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
createGroupRequest-- Returns:
- Result of the CreateGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createGroup
default CreateGroupResponse createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest) throws InvalidParameterException, GroupExistsException, ResourceNotFoundException, TooManyRequestsException, LimitExceededException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Creates a new group in the specified user pool. For more information about user pool groups see Adding groups to a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
CreateGroupRequest.Builderavoiding the need to create one manually viaCreateGroupRequest.builder()- Parameters:
createGroupRequest- AConsumerthat will call methods onCreateGroupRequest.Builderto create a request.- Returns:
- Result of the CreateGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createIdentityProvider
default CreateIdentityProviderResponse createIdentityProvider(CreateIdentityProviderRequest createIdentityProviderRequest) throws InvalidParameterException, DuplicateProviderException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, LimitExceededException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Adds a configuration and trust relationship between a third-party identity provider (IdP) and a user pool. Amazon Cognito accepts sign-in with third-party identity providers through managed login and OIDC relying-party libraries. For more information, see Third-party IdP sign-in.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
createIdentityProviderRequest-- Returns:
- Result of the CreateIdentityProvider operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createIdentityProvider
default CreateIdentityProviderResponse createIdentityProvider(Consumer<CreateIdentityProviderRequest.Builder> createIdentityProviderRequest) throws InvalidParameterException, DuplicateProviderException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, LimitExceededException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Adds a configuration and trust relationship between a third-party identity provider (IdP) and a user pool. Amazon Cognito accepts sign-in with third-party identity providers through managed login and OIDC relying-party libraries. For more information, see Third-party IdP sign-in.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
CreateIdentityProviderRequest.Builderavoiding the need to create one manually viaCreateIdentityProviderRequest.builder()- Parameters:
createIdentityProviderRequest- AConsumerthat will call methods onCreateIdentityProviderRequest.Builderto create a request.- Returns:
- Result of the CreateIdentityProvider operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createManagedLoginBranding
default CreateManagedLoginBrandingResponse createManagedLoginBranding(CreateManagedLoginBrandingRequest createManagedLoginBrandingRequest) throws ResourceNotFoundException, ConcurrentModificationException, ManagedLoginBrandingExistsException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, LimitExceededException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Creates a new set of branding settings for a user pool style and associates it with an app client. This operation is the programmatic option for the creation of a new style in the branding designer.
Provides values for UI customization in a
SettingsJSON object and image files in anAssetsarray. To send the JSON objectDocumenttype parameter inSettings, you might need to update to the most recent version of your Amazon Web Services SDK. To create a new style with default settings, setUseCognitoProvidedValuestotrueand don't provide values for any other options.This operation has a 2-megabyte request-size limit and include the CSS settings and image assets for your app client. Your branding settings might exceed 2MB in size. Amazon Cognito doesn't require that you pass all parameters in one request and preserves existing style settings that you don't specify. If your request is larger than 2MB, separate it into multiple requests, each with a size smaller than the limit.
As a best practice, modify the output of DescribeManagedLoginBrandingByClient into the request parameters for this operation. To get all settings, set
ReturnMergedResourcestotrue. For more information, see API and SDK operations for managed login branding.Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
createManagedLoginBrandingRequest-- Returns:
- Result of the CreateManagedLoginBranding operation returned by the service.
- Throws:
ResourceNotFoundException- This exception is thrown when the Amazon Cognito service can't find the requested resource.ConcurrentModificationException- This exception is thrown if two or more modifications are happening concurrently.ManagedLoginBrandingExistsException- This exception is thrown when you attempt to apply a managed login branding style to an app client that already has an assigned style.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.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.AwsServiceException- See Also:
- AWS API Documentation
-
createManagedLoginBranding
default CreateManagedLoginBrandingResponse createManagedLoginBranding(Consumer<CreateManagedLoginBrandingRequest.Builder> createManagedLoginBrandingRequest) throws ResourceNotFoundException, ConcurrentModificationException, ManagedLoginBrandingExistsException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, LimitExceededException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Creates a new set of branding settings for a user pool style and associates it with an app client. This operation is the programmatic option for the creation of a new style in the branding designer.
Provides values for UI customization in a
SettingsJSON object and image files in anAssetsarray. To send the JSON objectDocumenttype parameter inSettings, you might need to update to the most recent version of your Amazon Web Services SDK. To create a new style with default settings, setUseCognitoProvidedValuestotrueand don't provide values for any other options.This operation has a 2-megabyte request-size limit and include the CSS settings and image assets for your app client. Your branding settings might exceed 2MB in size. Amazon Cognito doesn't require that you pass all parameters in one request and preserves existing style settings that you don't specify. If your request is larger than 2MB, separate it into multiple requests, each with a size smaller than the limit.
As a best practice, modify the output of DescribeManagedLoginBrandingByClient into the request parameters for this operation. To get all settings, set
ReturnMergedResourcestotrue. For more information, see API and SDK operations for managed login branding.Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
CreateManagedLoginBrandingRequest.Builderavoiding the need to create one manually viaCreateManagedLoginBrandingRequest.builder()- Parameters:
createManagedLoginBrandingRequest- AConsumerthat will call methods onCreateManagedLoginBrandingRequest.Builderto create a request.- Returns:
- Result of the CreateManagedLoginBranding operation returned by the service.
- Throws:
ResourceNotFoundException- This exception is thrown when the Amazon Cognito service can't find the requested resource.ConcurrentModificationException- This exception is thrown if two or more modifications are happening concurrently.ManagedLoginBrandingExistsException- This exception is thrown when you attempt to apply a managed login branding style to an app client that already has an assigned style.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.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.AwsServiceException- See Also:
- AWS API Documentation
-
createResourceServer
default CreateResourceServerResponse createResourceServer(CreateResourceServerRequest createResourceServerRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, LimitExceededException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Creates a new OAuth2.0 resource server and defines custom scopes within it. Resource servers are associated with custom scopes and machine-to-machine (M2M) authorization. For more information, see Access control with resource servers.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
createResourceServerRequest-- Returns:
- Result of the CreateResourceServer operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createResourceServer
default CreateResourceServerResponse createResourceServer(Consumer<CreateResourceServerRequest.Builder> createResourceServerRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, LimitExceededException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Creates a new OAuth2.0 resource server and defines custom scopes within it. Resource servers are associated with custom scopes and machine-to-machine (M2M) authorization. For more information, see Access control with resource servers.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
CreateResourceServerRequest.Builderavoiding the need to create one manually viaCreateResourceServerRequest.builder()- Parameters:
createResourceServerRequest- AConsumerthat will call methods onCreateResourceServerRequest.Builderto create a request.- Returns:
- Result of the CreateResourceServer operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createUserImportJob
default CreateUserImportJobResponse createUserImportJob(CreateUserImportJobRequest createUserImportJobRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, PreconditionNotMetException, NotAuthorizedException, LimitExceededException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Creates a user import job. You can import users into user pools from a comma-separated values (CSV) file without adding Amazon Cognito MAU costs to your Amazon Web Services bill. To generate a template for your import, see GetCSVHeader. To learn more about CSV import, see Importing users from a CSV file.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
createUserImportJobRequest- Represents the request to create the user import job.- Returns:
- Result of the CreateUserImportJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createUserImportJob
default CreateUserImportJobResponse createUserImportJob(Consumer<CreateUserImportJobRequest.Builder> createUserImportJobRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, PreconditionNotMetException, NotAuthorizedException, LimitExceededException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Creates a user import job. You can import users into user pools from a comma-separated values (CSV) file without adding Amazon Cognito MAU costs to your Amazon Web Services bill. To generate a template for your import, see GetCSVHeader. To learn more about CSV import, see Importing users from a CSV file.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
CreateUserImportJobRequest.Builderavoiding the need to create one manually viaCreateUserImportJobRequest.builder()- Parameters:
createUserImportJobRequest- AConsumerthat will call methods onCreateUserImportJobRequest.Builderto create a request. Represents the request to create the user import job.- Returns:
- Result of the CreateUserImportJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createUserPool
default CreateUserPoolResponse createUserPool(CreateUserPoolRequest createUserPoolRequest) throws InvalidParameterException, TooManyRequestsException, LimitExceededException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InvalidEmailRoleAccessPolicyException, NotAuthorizedException, UserPoolTaggingException, InternalErrorException, TierChangeNotAllowedException, FeatureUnavailableInTierException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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 Services 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.
Creates a new Amazon Cognito user pool. This operation sets basic and advanced configuration options. You can create a user pool in the Amazon Cognito console to your preferences and use the output of DescribeUserPool to generate requests from that baseline.
If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
createUserPoolRequest- Represents the request to create a user pool.- Returns:
- Result of the CreateUserPool operation returned by the service.
- Throws:
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 trustcognito-idp.amazonaws.comor 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.TierChangeNotAllowedException- This exception is thrown when you've attempted to change your feature plan but the operation isn't permitted.FeatureUnavailableInTierException- This exception is thrown when a feature you attempted to configure isn't available in your current feature plan.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createUserPool
default CreateUserPoolResponse createUserPool(Consumer<CreateUserPoolRequest.Builder> createUserPoolRequest) throws InvalidParameterException, TooManyRequestsException, LimitExceededException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InvalidEmailRoleAccessPolicyException, NotAuthorizedException, UserPoolTaggingException, InternalErrorException, TierChangeNotAllowedException, FeatureUnavailableInTierException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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 Services 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.
Creates a new Amazon Cognito user pool. This operation sets basic and advanced configuration options. You can create a user pool in the Amazon Cognito console to your preferences and use the output of DescribeUserPool to generate requests from that baseline.
If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
CreateUserPoolRequest.Builderavoiding the need to create one manually viaCreateUserPoolRequest.builder()- Parameters:
createUserPoolRequest- AConsumerthat will call methods onCreateUserPoolRequest.Builderto create a request. Represents the request to create a user pool.- Returns:
- Result of the CreateUserPool operation returned by the service.
- Throws:
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 trustcognito-idp.amazonaws.comor 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.TierChangeNotAllowedException- This exception is thrown when you've attempted to change your feature plan but the operation isn't permitted.FeatureUnavailableInTierException- This exception is thrown when a feature you attempted to configure isn't available in your current feature plan.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createUserPoolClient
default CreateUserPoolClientResponse createUserPoolClient(CreateUserPoolClientRequest createUserPoolClientRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, LimitExceededException, NotAuthorizedException, ScopeDoesNotExistException, InvalidOAuthFlowException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Creates an app client in a user pool. This operation sets basic and advanced configuration options. You can create an app client in the Amazon Cognito console to your preferences and use the output of DescribeUserPoolClient to generate requests from that baseline.
New app clients activate token revocation by default. For more information about revoking tokens, see RevokeToken.
If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
createUserPoolClientRequest- Represents the request to create a user pool client.- Returns:
- Result of the CreateUserPoolClient operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createUserPoolClient
default CreateUserPoolClientResponse createUserPoolClient(Consumer<CreateUserPoolClientRequest.Builder> createUserPoolClientRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, LimitExceededException, NotAuthorizedException, ScopeDoesNotExistException, InvalidOAuthFlowException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Creates an app client in a user pool. This operation sets basic and advanced configuration options. You can create an app client in the Amazon Cognito console to your preferences and use the output of DescribeUserPoolClient to generate requests from that baseline.
New app clients activate token revocation by default. For more information about revoking tokens, see RevokeToken.
If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
CreateUserPoolClientRequest.Builderavoiding the need to create one manually viaCreateUserPoolClientRequest.builder()- Parameters:
createUserPoolClientRequest- AConsumerthat will call methods onCreateUserPoolClientRequest.Builderto create a request. Represents the request to create a user pool client.- Returns:
- Result of the CreateUserPoolClient operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createUserPoolDomain
default CreateUserPoolDomainResponse createUserPoolDomain(CreateUserPoolDomainRequest createUserPoolDomainRequest) throws InvalidParameterException, NotAuthorizedException, ResourceNotFoundException, LimitExceededException, InternalErrorException, FeatureUnavailableInTierException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
A user pool domain hosts managed login, an authorization server and web server for authentication in your application. This operation creates a new user pool prefix or custom domain and sets the managed login branding version. Set the branding version to
1for hosted UI (classic) or2for managed login. When you choose a custom domain, you must provide an SSL certificate in the US East (N. Virginia) Amazon Web Services Region in your request.Your prefix domain might take up to one minute to take effect. Your custom domain is online within five minutes, but it can take up to one hour to distribute your SSL certificate.
For more information about adding a custom domain to your user pool, see Configuring a user pool domain.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
createUserPoolDomainRequest-- Returns:
- Result of the CreateUserPoolDomain operation returned by the service.
- Throws:
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.FeatureUnavailableInTierException- This exception is thrown when a feature you attempted to configure isn't available in your current feature plan.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createUserPoolDomain
default CreateUserPoolDomainResponse createUserPoolDomain(Consumer<CreateUserPoolDomainRequest.Builder> createUserPoolDomainRequest) throws InvalidParameterException, NotAuthorizedException, ResourceNotFoundException, LimitExceededException, InternalErrorException, FeatureUnavailableInTierException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
A user pool domain hosts managed login, an authorization server and web server for authentication in your application. This operation creates a new user pool prefix or custom domain and sets the managed login branding version. Set the branding version to
1for hosted UI (classic) or2for managed login. When you choose a custom domain, you must provide an SSL certificate in the US East (N. Virginia) Amazon Web Services Region in your request.Your prefix domain might take up to one minute to take effect. Your custom domain is online within five minutes, but it can take up to one hour to distribute your SSL certificate.
For more information about adding a custom domain to your user pool, see Configuring a user pool domain.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
CreateUserPoolDomainRequest.Builderavoiding the need to create one manually viaCreateUserPoolDomainRequest.builder()- Parameters:
createUserPoolDomainRequest- AConsumerthat will call methods onCreateUserPoolDomainRequest.Builderto create a request.- Returns:
- Result of the CreateUserPoolDomain operation returned by the service.
- Throws:
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.FeatureUnavailableInTierException- This exception is thrown when a feature you attempted to configure isn't available in your current feature plan.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteGroup
default DeleteGroupResponse deleteGroup(DeleteGroupRequest deleteGroupRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Deletes a group from the specified user pool. When you delete a group, that group no longer contributes to users'
cognito:preferred_grouporcognito:groupsclaims, and no longer influence access-control decision that are based on group membership. For more information about user pool groups, see Adding groups to a user pool.Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
deleteGroupRequest-- Returns:
- Result of the DeleteGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteGroup
default DeleteGroupResponse deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Deletes a group from the specified user pool. When you delete a group, that group no longer contributes to users'
cognito:preferred_grouporcognito:groupsclaims, and no longer influence access-control decision that are based on group membership. For more information about user pool groups, see Adding groups to a user pool.Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
DeleteGroupRequest.Builderavoiding the need to create one manually viaDeleteGroupRequest.builder()- Parameters:
deleteGroupRequest- AConsumerthat will call methods onDeleteGroupRequest.Builderto create a request.- Returns:
- Result of the DeleteGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteIdentityProvider
default DeleteIdentityProviderResponse deleteIdentityProvider(DeleteIdentityProviderRequest deleteIdentityProviderRequest) throws InvalidParameterException, UnsupportedIdentityProviderException, ConcurrentModificationException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Deletes a user pool identity provider (IdP). After you delete an IdP, users can no longer sign in to your user pool through that IdP. For more information about user pool IdPs, see Third-party IdP sign-in.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
deleteIdentityProviderRequest-- Returns:
- Result of the DeleteIdentityProvider operation returned by the service.
- Throws:
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.ConcurrentModificationException- This exception is thrown if two or more modifications are happening concurrently.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteIdentityProvider
default DeleteIdentityProviderResponse deleteIdentityProvider(Consumer<DeleteIdentityProviderRequest.Builder> deleteIdentityProviderRequest) throws InvalidParameterException, UnsupportedIdentityProviderException, ConcurrentModificationException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Deletes a user pool identity provider (IdP). After you delete an IdP, users can no longer sign in to your user pool through that IdP. For more information about user pool IdPs, see Third-party IdP sign-in.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
DeleteIdentityProviderRequest.Builderavoiding the need to create one manually viaDeleteIdentityProviderRequest.builder()- Parameters:
deleteIdentityProviderRequest- AConsumerthat will call methods onDeleteIdentityProviderRequest.Builderto create a request.- Returns:
- Result of the DeleteIdentityProvider operation returned by the service.
- Throws:
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.ConcurrentModificationException- This exception is thrown if two or more modifications are happening concurrently.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteManagedLoginBranding
default DeleteManagedLoginBrandingResponse deleteManagedLoginBranding(DeleteManagedLoginBrandingRequest deleteManagedLoginBrandingRequest) throws ResourceNotFoundException, ConcurrentModificationException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Deletes a managed login branding style. When you delete a style, you delete the branding association for an app client. When an app client doesn't have a style assigned, your managed login pages for that app client are nonfunctional until you create a new style or switch the domain branding version.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
deleteManagedLoginBrandingRequest-- Returns:
- Result of the DeleteManagedLoginBranding operation returned by the service.
- Throws:
ResourceNotFoundException- This exception is thrown when the Amazon Cognito service can't find the requested resource.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.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteManagedLoginBranding
default DeleteManagedLoginBrandingResponse deleteManagedLoginBranding(Consumer<DeleteManagedLoginBrandingRequest.Builder> deleteManagedLoginBrandingRequest) throws ResourceNotFoundException, ConcurrentModificationException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Deletes a managed login branding style. When you delete a style, you delete the branding association for an app client. When an app client doesn't have a style assigned, your managed login pages for that app client are nonfunctional until you create a new style or switch the domain branding version.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
DeleteManagedLoginBrandingRequest.Builderavoiding the need to create one manually viaDeleteManagedLoginBrandingRequest.builder()- Parameters:
deleteManagedLoginBrandingRequest- AConsumerthat will call methods onDeleteManagedLoginBrandingRequest.Builderto create a request.- Returns:
- Result of the DeleteManagedLoginBranding operation returned by the service.
- Throws:
ResourceNotFoundException- This exception is thrown when the Amazon Cognito service can't find the requested resource.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.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteResourceServer
default DeleteResourceServerResponse deleteResourceServer(DeleteResourceServerRequest deleteResourceServerRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Deletes a resource server. After you delete a resource server, users can no longer generate access tokens with scopes that are associate with that resource server.
Resource servers are associated with custom scopes and machine-to-machine (M2M) authorization. For more information, see Access control with resource servers.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
deleteResourceServerRequest-- Returns:
- Result of the DeleteResourceServer operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteResourceServer
default DeleteResourceServerResponse deleteResourceServer(Consumer<DeleteResourceServerRequest.Builder> deleteResourceServerRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Deletes a resource server. After you delete a resource server, users can no longer generate access tokens with scopes that are associate with that resource server.
Resource servers are associated with custom scopes and machine-to-machine (M2M) authorization. For more information, see Access control with resource servers.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
DeleteResourceServerRequest.Builderavoiding the need to create one manually viaDeleteResourceServerRequest.builder()- Parameters:
deleteResourceServerRequest- AConsumerthat will call methods onDeleteResourceServerRequest.Builderto create a request.- Returns:
- Result of the DeleteResourceServer operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteUser
default DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Self-deletes a user profile. A deleted user profile can no longer be used to sign in and can't be restored.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
- Parameters:
deleteUserRequest- Represents the request to delete a user.- Returns:
- Result of the DeleteUser operation returned by the service.
- Throws:
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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteUser
default DeleteUserResponse deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Self-deletes a user profile. A deleted user profile can no longer be used to sign in and can't be restored.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
This is a convenience which creates an instance of the
DeleteUserRequest.Builderavoiding the need to create one manually viaDeleteUserRequest.builder()- Parameters:
deleteUserRequest- AConsumerthat will call methods onDeleteUserRequest.Builderto create a request. Represents the request to delete a user.- Returns:
- Result of the DeleteUser operation returned by the service.
- Throws:
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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteUserAttributes
default DeleteUserAttributesResponse deleteUserAttributes(DeleteUserAttributesRequest deleteUserAttributesRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Self-deletes attributes for a user. For example, your application can submit a request to this operation when a user wants to remove their
birthdateattribute value.Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
- Parameters:
deleteUserAttributesRequest- Represents the request to delete user attributes.- Returns:
- Result of the DeleteUserAttributes operation returned by the service.
- Throws:
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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteUserAttributes
default DeleteUserAttributesResponse deleteUserAttributes(Consumer<DeleteUserAttributesRequest.Builder> deleteUserAttributesRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Self-deletes attributes for a user. For example, your application can submit a request to this operation when a user wants to remove their
birthdateattribute value.Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
This is a convenience which creates an instance of the
DeleteUserAttributesRequest.Builderavoiding the need to create one manually viaDeleteUserAttributesRequest.builder()- Parameters:
deleteUserAttributesRequest- AConsumerthat will call methods onDeleteUserAttributesRequest.Builderto create a request. Represents the request to delete user attributes.- Returns:
- Result of the DeleteUserAttributes operation returned by the service.
- Throws:
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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteUserPool
default DeleteUserPoolResponse deleteUserPool(DeleteUserPoolRequest deleteUserPoolRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserImportInProgressException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Deletes a user pool. After you delete a user pool, users can no longer sign in to any associated applications.
- Parameters:
deleteUserPoolRequest- Represents the request to delete a user pool.- Returns:
- Result of the DeleteUserPool operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteUserPool
default DeleteUserPoolResponse deleteUserPool(Consumer<DeleteUserPoolRequest.Builder> deleteUserPoolRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserImportInProgressException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Deletes a user pool. After you delete a user pool, users can no longer sign in to any associated applications.
This is a convenience which creates an instance of the
DeleteUserPoolRequest.Builderavoiding the need to create one manually viaDeleteUserPoolRequest.builder()- Parameters:
deleteUserPoolRequest- AConsumerthat will call methods onDeleteUserPoolRequest.Builderto create a request. Represents the request to delete a user pool.- Returns:
- Result of the DeleteUserPool operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteUserPoolClient
default DeleteUserPoolClientResponse deleteUserPoolClient(DeleteUserPoolClientRequest deleteUserPoolClientRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, ConcurrentModificationException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Deletes a user pool app client. After you delete an app client, users can no longer sign in to the associated application.
- Parameters:
deleteUserPoolClientRequest- Represents the request to delete a user pool client.- Returns:
- Result of the DeleteUserPoolClient operation returned by the service.
- Throws:
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.ConcurrentModificationException- This exception is thrown if two or more modifications are happening concurrently.InternalErrorException- This exception is thrown when Amazon Cognito encounters an internal error.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteUserPoolClient
default DeleteUserPoolClientResponse deleteUserPoolClient(Consumer<DeleteUserPoolClientRequest.Builder> deleteUserPoolClientRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, ConcurrentModificationException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Deletes a user pool app client. After you delete an app client, users can no longer sign in to the associated application.
This is a convenience which creates an instance of the
DeleteUserPoolClientRequest.Builderavoiding the need to create one manually viaDeleteUserPoolClientRequest.builder()- Parameters:
deleteUserPoolClientRequest- AConsumerthat will call methods onDeleteUserPoolClientRequest.Builderto create a request. Represents the request to delete a user pool client.- Returns:
- Result of the DeleteUserPoolClient operation returned by the service.
- Throws:
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.ConcurrentModificationException- This exception is thrown if two or more modifications are happening concurrently.InternalErrorException- This exception is thrown when Amazon Cognito encounters an internal error.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteUserPoolDomain
default DeleteUserPoolDomainResponse deleteUserPoolDomain(DeleteUserPoolDomainRequest deleteUserPoolDomainRequest) throws NotAuthorizedException, InvalidParameterException, ResourceNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Given a user pool ID and domain identifier, deletes a user pool domain. After you delete a user pool domain, your managed login pages and authorization server are no longer available.
- Parameters:
deleteUserPoolDomainRequest-- Returns:
- Result of the DeleteUserPoolDomain operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteUserPoolDomain
default DeleteUserPoolDomainResponse deleteUserPoolDomain(Consumer<DeleteUserPoolDomainRequest.Builder> deleteUserPoolDomainRequest) throws NotAuthorizedException, InvalidParameterException, ResourceNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Given a user pool ID and domain identifier, deletes a user pool domain. After you delete a user pool domain, your managed login pages and authorization server are no longer available.
This is a convenience which creates an instance of the
DeleteUserPoolDomainRequest.Builderavoiding the need to create one manually viaDeleteUserPoolDomainRequest.builder()- Parameters:
deleteUserPoolDomainRequest- AConsumerthat will call methods onDeleteUserPoolDomainRequest.Builderto create a request.- Returns:
- Result of the DeleteUserPoolDomain operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteWebAuthnCredential
default DeleteWebAuthnCredentialResponse deleteWebAuthnCredential(DeleteWebAuthnCredentialRequest deleteWebAuthnCredentialRequest) throws ForbiddenException, InternalErrorException, InvalidParameterException, NotAuthorizedException, ResourceNotFoundException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Deletes a registered passkey, or webauthN, authenticator for the currently signed-in user.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
- Parameters:
deleteWebAuthnCredentialRequest-- Returns:
- Result of the DeleteWebAuthnCredential operation returned by the service.
- Throws:
ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.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.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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteWebAuthnCredential
default DeleteWebAuthnCredentialResponse deleteWebAuthnCredential(Consumer<DeleteWebAuthnCredentialRequest.Builder> deleteWebAuthnCredentialRequest) throws ForbiddenException, InternalErrorException, InvalidParameterException, NotAuthorizedException, ResourceNotFoundException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Deletes a registered passkey, or webauthN, authenticator for the currently signed-in user.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
This is a convenience which creates an instance of the
DeleteWebAuthnCredentialRequest.Builderavoiding the need to create one manually viaDeleteWebAuthnCredentialRequest.builder()- Parameters:
deleteWebAuthnCredentialRequest- AConsumerthat will call methods onDeleteWebAuthnCredentialRequest.Builderto create a request.- Returns:
- Result of the DeleteWebAuthnCredential operation returned by the service.
- Throws:
ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.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.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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeIdentityProvider
default DescribeIdentityProviderResponse describeIdentityProvider(DescribeIdentityProviderRequest describeIdentityProviderRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Given a user pool ID and identity provider (IdP) name, returns details about the IdP.
- Parameters:
describeIdentityProviderRequest-- Returns:
- Result of the DescribeIdentityProvider operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeIdentityProvider
default DescribeIdentityProviderResponse describeIdentityProvider(Consumer<DescribeIdentityProviderRequest.Builder> describeIdentityProviderRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Given a user pool ID and identity provider (IdP) name, returns details about the IdP.
This is a convenience which creates an instance of the
DescribeIdentityProviderRequest.Builderavoiding the need to create one manually viaDescribeIdentityProviderRequest.builder()- Parameters:
describeIdentityProviderRequest- AConsumerthat will call methods onDescribeIdentityProviderRequest.Builderto create a request.- Returns:
- Result of the DescribeIdentityProvider operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeManagedLoginBranding
default DescribeManagedLoginBrandingResponse describeManagedLoginBranding(DescribeManagedLoginBrandingRequest describeManagedLoginBrandingRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Given the ID of a managed login branding style, returns detailed information about the style.
- Parameters:
describeManagedLoginBrandingRequest-- Returns:
- Result of the DescribeManagedLoginBranding operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeManagedLoginBranding
default DescribeManagedLoginBrandingResponse describeManagedLoginBranding(Consumer<DescribeManagedLoginBrandingRequest.Builder> describeManagedLoginBrandingRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Given the ID of a managed login branding style, returns detailed information about the style.
This is a convenience which creates an instance of the
DescribeManagedLoginBrandingRequest.Builderavoiding the need to create one manually viaDescribeManagedLoginBrandingRequest.builder()- Parameters:
describeManagedLoginBrandingRequest- AConsumerthat will call methods onDescribeManagedLoginBrandingRequest.Builderto create a request.- Returns:
- Result of the DescribeManagedLoginBranding operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeManagedLoginBrandingByClient
default DescribeManagedLoginBrandingByClientResponse describeManagedLoginBrandingByClient(DescribeManagedLoginBrandingByClientRequest describeManagedLoginBrandingByClientRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Given the ID of a user pool app client, returns detailed information about the style assigned to the app client.
- Parameters:
describeManagedLoginBrandingByClientRequest-- Returns:
- Result of the DescribeManagedLoginBrandingByClient operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeManagedLoginBrandingByClient
default DescribeManagedLoginBrandingByClientResponse describeManagedLoginBrandingByClient(Consumer<DescribeManagedLoginBrandingByClientRequest.Builder> describeManagedLoginBrandingByClientRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Given the ID of a user pool app client, returns detailed information about the style assigned to the app client.
This is a convenience which creates an instance of the
DescribeManagedLoginBrandingByClientRequest.Builderavoiding the need to create one manually viaDescribeManagedLoginBrandingByClientRequest.builder()- Parameters:
describeManagedLoginBrandingByClientRequest- AConsumerthat will call methods onDescribeManagedLoginBrandingByClientRequest.Builderto create a request.- Returns:
- Result of the DescribeManagedLoginBrandingByClient operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeResourceServer
default DescribeResourceServerResponse describeResourceServer(DescribeResourceServerRequest describeResourceServerRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Describes a resource server. For more information about resource servers, see Access control with resource servers.
- Parameters:
describeResourceServerRequest-- Returns:
- Result of the DescribeResourceServer operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeResourceServer
default DescribeResourceServerResponse describeResourceServer(Consumer<DescribeResourceServerRequest.Builder> describeResourceServerRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Describes a resource server. For more information about resource servers, see Access control with resource servers.
This is a convenience which creates an instance of the
DescribeResourceServerRequest.Builderavoiding the need to create one manually viaDescribeResourceServerRequest.builder()- Parameters:
describeResourceServerRequest- AConsumerthat will call methods onDescribeResourceServerRequest.Builderto create a request.- Returns:
- Result of the DescribeResourceServer operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeRiskConfiguration
default DescribeRiskConfigurationResponse describeRiskConfiguration(DescribeRiskConfigurationRequest describeRiskConfigurationRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserPoolAddOnNotEnabledException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Given an app client or user pool ID where threat protection is configured, describes the risk configuration. This operation returns details about adaptive authentication, compromised credentials, and IP-address allow- and denylists. For more information about threat protection, see Threat protection.
- Parameters:
describeRiskConfigurationRequest-- Returns:
- Result of the DescribeRiskConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeRiskConfiguration
default DescribeRiskConfigurationResponse describeRiskConfiguration(Consumer<DescribeRiskConfigurationRequest.Builder> describeRiskConfigurationRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserPoolAddOnNotEnabledException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Given an app client or user pool ID where threat protection is configured, describes the risk configuration. This operation returns details about adaptive authentication, compromised credentials, and IP-address allow- and denylists. For more information about threat protection, see Threat protection.
This is a convenience which creates an instance of the
DescribeRiskConfigurationRequest.Builderavoiding the need to create one manually viaDescribeRiskConfigurationRequest.builder()- Parameters:
describeRiskConfigurationRequest- AConsumerthat will call methods onDescribeRiskConfigurationRequest.Builderto create a request.- Returns:
- Result of the DescribeRiskConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeUserImportJob
default DescribeUserImportJobResponse describeUserImportJob(DescribeUserImportJobRequest describeUserImportJobRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Describes a user import job. For more information about user CSV import, see Importing users from a CSV file.
- Parameters:
describeUserImportJobRequest- Represents the request to describe the user import job.- Returns:
- Result of the DescribeUserImportJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeUserImportJob
default DescribeUserImportJobResponse describeUserImportJob(Consumer<DescribeUserImportJobRequest.Builder> describeUserImportJobRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Describes a user import job. For more information about user CSV import, see Importing users from a CSV file.
This is a convenience which creates an instance of the
DescribeUserImportJobRequest.Builderavoiding the need to create one manually viaDescribeUserImportJobRequest.builder()- Parameters:
describeUserImportJobRequest- AConsumerthat will call methods onDescribeUserImportJobRequest.Builderto create a request. Represents the request to describe the user import job.- Returns:
- Result of the DescribeUserImportJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeUserPool
default DescribeUserPoolResponse describeUserPool(DescribeUserPoolRequest describeUserPoolRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserPoolTaggingException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Given a user pool ID, returns configuration information. This operation is useful when you want to inspect an existing user pool and programmatically replicate the configuration to another user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
describeUserPoolRequest- Represents the request to describe the user pool.- Returns:
- Result of the DescribeUserPool operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeUserPool
default DescribeUserPoolResponse describeUserPool(Consumer<DescribeUserPoolRequest.Builder> describeUserPoolRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserPoolTaggingException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Given a user pool ID, returns configuration information. This operation is useful when you want to inspect an existing user pool and programmatically replicate the configuration to another user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
DescribeUserPoolRequest.Builderavoiding the need to create one manually viaDescribeUserPoolRequest.builder()- Parameters:
describeUserPoolRequest- AConsumerthat will call methods onDescribeUserPoolRequest.Builderto create a request. Represents the request to describe the user pool.- Returns:
- Result of the DescribeUserPool operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeUserPoolClient
default DescribeUserPoolClientResponse describeUserPoolClient(DescribeUserPoolClientRequest describeUserPoolClientRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Given an app client ID, returns configuration information. This operation is useful when you want to inspect an existing app client and programmatically replicate the configuration to another app client. For more information about app clients, see App clients.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
describeUserPoolClientRequest- Represents the request to describe a user pool client.- Returns:
- Result of the DescribeUserPoolClient operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeUserPoolClient
default DescribeUserPoolClientResponse describeUserPoolClient(Consumer<DescribeUserPoolClientRequest.Builder> describeUserPoolClientRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Given an app client ID, returns configuration information. This operation is useful when you want to inspect an existing app client and programmatically replicate the configuration to another app client. For more information about app clients, see App clients.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
DescribeUserPoolClientRequest.Builderavoiding the need to create one manually viaDescribeUserPoolClientRequest.builder()- Parameters:
describeUserPoolClientRequest- AConsumerthat will call methods onDescribeUserPoolClientRequest.Builderto create a request. Represents the request to describe a user pool client.- Returns:
- Result of the DescribeUserPoolClient operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeUserPoolDomain
default DescribeUserPoolDomainResponse describeUserPoolDomain(DescribeUserPoolDomainRequest describeUserPoolDomainRequest) throws NotAuthorizedException, InvalidParameterException, ResourceNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Given a user pool domain name, returns information about the domain configuration.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
describeUserPoolDomainRequest-- Returns:
- Result of the DescribeUserPoolDomain operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeUserPoolDomain
default DescribeUserPoolDomainResponse describeUserPoolDomain(Consumer<DescribeUserPoolDomainRequest.Builder> describeUserPoolDomainRequest) throws NotAuthorizedException, InvalidParameterException, ResourceNotFoundException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Given a user pool domain name, returns information about the domain configuration.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
DescribeUserPoolDomainRequest.Builderavoiding the need to create one manually viaDescribeUserPoolDomainRequest.builder()- Parameters:
describeUserPoolDomainRequest- AConsumerthat will call methods onDescribeUserPoolDomainRequest.Builderto create a request.- Returns:
- Result of the DescribeUserPoolDomain operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
forgetDevice
default ForgetDeviceResponse forgetDevice(ForgetDeviceRequest forgetDeviceRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, InvalidUserPoolConfigurationException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Forgets the specified device. For more information about device authentication, see Working with user devices in your user pool.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
- Parameters:
forgetDeviceRequest- Represents the request to forget the device.- Returns:
- Result of the ForgetDevice operation returned by the service.
- Throws:
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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
forgetDevice
default ForgetDeviceResponse forgetDevice(Consumer<ForgetDeviceRequest.Builder> forgetDeviceRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, InvalidUserPoolConfigurationException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Forgets the specified device. For more information about device authentication, see Working with user devices in your user pool.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
This is a convenience which creates an instance of the
ForgetDeviceRequest.Builderavoiding the need to create one manually viaForgetDeviceRequest.builder()- Parameters:
forgetDeviceRequest- AConsumerthat will call methods onForgetDeviceRequest.Builderto create a request. Represents the request to forget the device.- Returns:
- Result of the ForgetDevice operation returned by the service.
- Throws:
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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
forgotPassword
default ForgotPasswordResponse forgotPassword(ForgotPasswordRequest forgotPasswordRequest) throws ResourceNotFoundException, InvalidParameterException, UnexpectedLambdaException, UserLambdaValidationException, NotAuthorizedException, InvalidLambdaResponseException, TooManyRequestsException, LimitExceededException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InvalidEmailRoleAccessPolicyException, CodeDeliveryFailureException, UserNotFoundException, InternalErrorException, ForbiddenException, 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
Usernameparameter, 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. To use the confirmation code for resetting the password, call ConfirmForgotPassword.If neither a verified phone number nor a verified email exists, this API returns
InvalidParameterException. If your app client has a client secret and you don't provide aSECRET_HASHparameter, this API returnsNotAuthorizedException.To use this API operation, your user pool must have self-service account recovery configured. Use AdminSetUserPassword if you manage passwords as an administrator.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
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 Services 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.
- Parameters:
forgotPasswordRequest- Represents the request to reset a user's password.- Returns:
- Result of the ForgotPassword operation returned by the service.
- Throws:
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 trustcognito-idp.amazonaws.comor 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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
forgotPassword
default ForgotPasswordResponse forgotPassword(Consumer<ForgotPasswordRequest.Builder> forgotPasswordRequest) throws ResourceNotFoundException, InvalidParameterException, UnexpectedLambdaException, UserLambdaValidationException, NotAuthorizedException, InvalidLambdaResponseException, TooManyRequestsException, LimitExceededException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InvalidEmailRoleAccessPolicyException, CodeDeliveryFailureException, UserNotFoundException, InternalErrorException, ForbiddenException, 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
Usernameparameter, 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. To use the confirmation code for resetting the password, call ConfirmForgotPassword.If neither a verified phone number nor a verified email exists, this API returns
InvalidParameterException. If your app client has a client secret and you don't provide aSECRET_HASHparameter, this API returnsNotAuthorizedException.To use this API operation, your user pool must have self-service account recovery configured. Use AdminSetUserPassword if you manage passwords as an administrator.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
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 Services 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.Builderavoiding the need to create one manually viaForgotPasswordRequest.builder()- Parameters:
forgotPasswordRequest- AConsumerthat will call methods onForgotPasswordRequest.Builderto create a request. Represents the request to reset a user's password.- Returns:
- Result of the ForgotPassword operation returned by the service.
- Throws:
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 trustcognito-idp.amazonaws.comor 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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getCSVHeader
default 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.
- Parameters:
getCsvHeaderRequest- Represents the request to get the header information of the CSV file for the user import job.- Returns:
- Result of the GetCSVHeader operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getCSVHeader
default 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.Builderavoiding the need to create one manually viaGetCsvHeaderRequest.builder()- Parameters:
getCsvHeaderRequest- AConsumerthat will call methods onGetCsvHeaderRequest.Builderto create a request. Represents the request to get the header information of the CSV file for the user import job.- Returns:
- Result of the GetCSVHeader operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getDevice
default GetDeviceResponse getDevice(GetDeviceRequest getDeviceRequest) throws ResourceNotFoundException, InvalidParameterException, InvalidUserPoolConfigurationException, NotAuthorizedException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Gets the device. For more information about device authentication, see Working with user devices in your user pool.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
- Parameters:
getDeviceRequest- Represents the request to get the device.- Returns:
- Result of the GetDevice operation returned by the service.
- Throws:
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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getDevice
default GetDeviceResponse getDevice(Consumer<GetDeviceRequest.Builder> getDeviceRequest) throws ResourceNotFoundException, InvalidParameterException, InvalidUserPoolConfigurationException, NotAuthorizedException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Gets the device. For more information about device authentication, see Working with user devices in your user pool.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
This is a convenience which creates an instance of the
GetDeviceRequest.Builderavoiding the need to create one manually viaGetDeviceRequest.builder()- Parameters:
getDeviceRequest- AConsumerthat will call methods onGetDeviceRequest.Builderto create a request. Represents the request to get the device.- Returns:
- Result of the GetDevice operation returned by the service.
- Throws:
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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getGroup
default GetGroupResponse getGroup(GetGroupRequest getGroupRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Gets a group.
Calling this action requires developer credentials.
- Parameters:
getGroupRequest-- Returns:
- Result of the GetGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getGroup
default 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.Builderavoiding the need to create one manually viaGetGroupRequest.builder()- Parameters:
getGroupRequest- AConsumerthat will call methods onGetGroupRequest.Builderto create a request.- Returns:
- Result of the GetGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getIdentityProviderByIdentifier
default GetIdentityProviderByIdentifierResponse getIdentityProviderByIdentifier(GetIdentityProviderByIdentifierRequest getIdentityProviderByIdentifierRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Gets the specified IdP.
- Parameters:
getIdentityProviderByIdentifierRequest-- Returns:
- Result of the GetIdentityProviderByIdentifier operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getIdentityProviderByIdentifier
default 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.Builderavoiding the need to create one manually viaGetIdentityProviderByIdentifierRequest.builder()- Parameters:
getIdentityProviderByIdentifierRequest- AConsumerthat will call methods onGetIdentityProviderByIdentifierRequest.Builderto create a request.- Returns:
- Result of the GetIdentityProviderByIdentifier operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getLogDeliveryConfiguration
default GetLogDeliveryConfigurationResponse getLogDeliveryConfiguration(GetLogDeliveryConfigurationRequest getLogDeliveryConfigurationRequest) throws InvalidParameterException, InternalErrorException, TooManyRequestsException, NotAuthorizedException, ResourceNotFoundException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Gets the logging configuration of a user pool.
- Parameters:
getLogDeliveryConfigurationRequest-- Returns:
- Result of the GetLogDeliveryConfiguration operation returned by the service.
- Throws:
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.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.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.AwsServiceException- See Also:
- AWS API Documentation
-
getLogDeliveryConfiguration
default GetLogDeliveryConfigurationResponse getLogDeliveryConfiguration(Consumer<GetLogDeliveryConfigurationRequest.Builder> getLogDeliveryConfigurationRequest) throws InvalidParameterException, InternalErrorException, TooManyRequestsException, NotAuthorizedException, ResourceNotFoundException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Gets the logging configuration of a user pool.
This is a convenience which creates an instance of the
GetLogDeliveryConfigurationRequest.Builderavoiding the need to create one manually viaGetLogDeliveryConfigurationRequest.builder()- Parameters:
getLogDeliveryConfigurationRequest- AConsumerthat will call methods onGetLogDeliveryConfigurationRequest.Builderto create a request.- Returns:
- Result of the GetLogDeliveryConfiguration operation returned by the service.
- Throws:
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.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.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.AwsServiceException- See Also:
- AWS API Documentation
-
getSigningCertificate
default GetSigningCertificateResponse getSigningCertificate(GetSigningCertificateRequest getSigningCertificateRequest) throws InternalErrorException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
This method takes a user pool ID, and returns the signing certificate. The issued certificate is valid for 10 years from the date of issue.
Amazon Cognito issues and assigns a new signing certificate annually. This process returns a new value in the response to
GetSigningCertificate, but doesn't invalidate the original certificate.- Parameters:
getSigningCertificateRequest- Request to get a signing certificate from Amazon Cognito.- Returns:
- Result of the GetSigningCertificate operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getSigningCertificate
default 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. The issued certificate is valid for 10 years from the date of issue.
Amazon Cognito issues and assigns a new signing certificate annually. This process returns a new value in the response to
GetSigningCertificate, but doesn't invalidate the original certificate.
This is a convenience which creates an instance of the
GetSigningCertificateRequest.Builderavoiding the need to create one manually viaGetSigningCertificateRequest.builder()- Parameters:
getSigningCertificateRequest- AConsumerthat will call methods onGetSigningCertificateRequest.Builderto create a request. Request to get a signing certificate from Amazon Cognito.- Returns:
- Result of the GetSigningCertificate operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getUICustomization
default 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
clientIdisALL), then that information is returned. If nothing is present, then an empty shape is returned.- Parameters:
getUiCustomizationRequest-- Returns:
- Result of the GetUICustomization operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getUICustomization
default 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
clientIdisALL), 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.Builderavoiding the need to create one manually viaGetUiCustomizationRequest.builder()- Parameters:
getUiCustomizationRequest- AConsumerthat will call methods onGetUiCustomizationRequest.Builderto create a request.- Returns:
- Result of the GetUICustomization operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getUser
default GetUserResponse getUser(GetUserRequest getUserRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Gets the user attributes and metadata for a user.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
- Parameters:
getUserRequest- Represents the request to get information about the user.- Returns:
- Result of the GetUser operation returned by the service.
- Throws:
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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getUser
default GetUserResponse getUser(Consumer<GetUserRequest.Builder> getUserRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Gets the user attributes and metadata for a user.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
This is a convenience which creates an instance of the
GetUserRequest.Builderavoiding the need to create one manually viaGetUserRequest.builder()- Parameters:
getUserRequest- AConsumerthat will call methods onGetUserRequest.Builderto create a request. Represents the request to get information about the user.- Returns:
- Result of the GetUser operation returned by the service.
- Throws:
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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getUserAttributeVerificationCode
default GetUserAttributeVerificationCodeResponse getUserAttributeVerificationCode(GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UnexpectedLambdaException, UserLambdaValidationException, InvalidLambdaResponseException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InvalidEmailRoleAccessPolicyException, CodeDeliveryFailureException, LimitExceededException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, ForbiddenException, 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.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
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 Services 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.
- Parameters:
getUserAttributeVerificationCodeRequest- Represents the request to get user attribute verification.- Returns:
- Result of the GetUserAttributeVerificationCode operation returned by the service.
- Throws:
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 trustcognito-idp.amazonaws.comor 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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getUserAttributeVerificationCode
default GetUserAttributeVerificationCodeResponse getUserAttributeVerificationCode(Consumer<GetUserAttributeVerificationCodeRequest.Builder> getUserAttributeVerificationCodeRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UnexpectedLambdaException, UserLambdaValidationException, InvalidLambdaResponseException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InvalidEmailRoleAccessPolicyException, CodeDeliveryFailureException, LimitExceededException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, ForbiddenException, 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.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
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 Services 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.Builderavoiding the need to create one manually viaGetUserAttributeVerificationCodeRequest.builder()- Parameters:
getUserAttributeVerificationCodeRequest- AConsumerthat will call methods onGetUserAttributeVerificationCodeRequest.Builderto create a request. Represents the request to get user attribute verification.- Returns:
- Result of the GetUserAttributeVerificationCode operation returned by the service.
- Throws:
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 trustcognito-idp.amazonaws.comor 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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getUserAuthFactors
default GetUserAuthFactorsResponse getUserAuthFactors(GetUserAuthFactorsRequest getUserAuthFactorsRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the authentication options for the currently signed-in user. Returns the following:
-
The user's multi-factor authentication (MFA) preferences.
-
The user's options in the
USER_AUTHflow that they can select in aSELECT_CHALLENGEresponse or request in aPREFERRED_CHALLENGErequest.
- Parameters:
getUserAuthFactorsRequest-- Returns:
- Result of the GetUserAuthFactors operation returned by the service.
- Throws:
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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
getUserAuthFactors
default GetUserAuthFactorsResponse getUserAuthFactors(Consumer<GetUserAuthFactorsRequest.Builder> getUserAuthFactorsRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the authentication options for the currently signed-in user. Returns the following:
-
The user's multi-factor authentication (MFA) preferences.
-
The user's options in the
USER_AUTHflow that they can select in aSELECT_CHALLENGEresponse or request in aPREFERRED_CHALLENGErequest.
This is a convenience which creates an instance of the
GetUserAuthFactorsRequest.Builderavoiding the need to create one manually viaGetUserAuthFactorsRequest.builder()- Parameters:
getUserAuthFactorsRequest- AConsumerthat will call methods onGetUserAuthFactorsRequest.Builderto create a request.- Returns:
- Result of the GetUserAuthFactors operation returned by the service.
- Throws:
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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
getUserPoolMfaConfig
default GetUserPoolMfaConfigResponse getUserPoolMfaConfig(GetUserPoolMfaConfigRequest getUserPoolMfaConfigRequest) throws InvalidParameterException, TooManyRequestsException, ResourceNotFoundException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Gets the user pool multi-factor authentication (MFA) configuration.
- Parameters:
getUserPoolMfaConfigRequest-- Returns:
- Result of the GetUserPoolMfaConfig operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getUserPoolMfaConfig
default 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.Builderavoiding the need to create one manually viaGetUserPoolMfaConfigRequest.builder()- Parameters:
getUserPoolMfaConfigRequest- AConsumerthat will call methods onGetUserPoolMfaConfigRequest.Builderto create a request.- Returns:
- Result of the GetUserPoolMfaConfig operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
globalSignOut
default GlobalSignOutResponse globalSignOut(GlobalSignOutRequest globalSignOutRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, PasswordResetRequiredException, UserNotConfirmedException, InternalErrorException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Invalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user. Call this operation when your user signs out of your app. This results in the following behavior.
-
Amazon Cognito no longer accepts token-authorized user operations that you authorize with a signed-out user's access tokens. For more information, see Using the Amazon Cognito user pools API and user pool endpoints.
Amazon Cognito returns an
Access Token has been revokederror when your app attempts to authorize a user pools API request with a revoked access token that contains the scopeaws.cognito.signin.user.admin. -
Amazon Cognito no longer accepts a signed-out user's ID token in a GetId request to an identity pool with
ServerSideTokenCheckenabled for its user pool IdP configuration in CognitoIdentityProvider. -
Amazon Cognito no longer accepts a signed-out user's refresh tokens in refresh requests.
Other requests might be valid until your user's token expires. This operation doesn't clear the managed login session cookie. To clear the session for a user who signed in with managed login or the classic hosted UI, direct their browser session to the logout endpoint.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
- Parameters:
globalSignOutRequest- Represents the request to sign out all devices.- Returns:
- Result of the GlobalSignOut operation returned by the service.
- Throws:
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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
globalSignOut
default GlobalSignOutResponse globalSignOut(Consumer<GlobalSignOutRequest.Builder> globalSignOutRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, PasswordResetRequiredException, UserNotConfirmedException, InternalErrorException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Invalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user. Call this operation when your user signs out of your app. This results in the following behavior.
-
Amazon Cognito no longer accepts token-authorized user operations that you authorize with a signed-out user's access tokens. For more information, see Using the Amazon Cognito user pools API and user pool endpoints.
Amazon Cognito returns an
Access Token has been revokederror when your app attempts to authorize a user pools API request with a revoked access token that contains the scopeaws.cognito.signin.user.admin. -
Amazon Cognito no longer accepts a signed-out user's ID token in a GetId request to an identity pool with
ServerSideTokenCheckenabled for its user pool IdP configuration in CognitoIdentityProvider. -
Amazon Cognito no longer accepts a signed-out user's refresh tokens in refresh requests.
Other requests might be valid until your user's token expires. This operation doesn't clear the managed login session cookie. To clear the session for a user who signed in with managed login or the classic hosted UI, direct their browser session to the logout endpoint.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
This is a convenience which creates an instance of the
GlobalSignOutRequest.Builderavoiding the need to create one manually viaGlobalSignOutRequest.builder()- Parameters:
globalSignOutRequest- AConsumerthat will call methods onGlobalSignOutRequest.Builderto create a request. Represents the request to sign out all devices.- Returns:
- Result of the GlobalSignOut operation returned by the service.
- Throws:
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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
initiateAuth
default InitiateAuthResponse initiateAuth(InitiateAuthRequest initiateAuthRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, UnexpectedLambdaException, InvalidUserPoolConfigurationException, UserLambdaValidationException, InvalidLambdaResponseException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, InvalidSmsRoleAccessPolicyException, InvalidEmailRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, ForbiddenException, 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.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
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 Services 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.
- Parameters:
initiateAuthRequest- Initiates the authentication request.- Returns:
- Result of the InitiateAuth operation returned by the service.
- Throws:
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.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 trustcognito-idp.amazonaws.comor the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
initiateAuth
default InitiateAuthResponse initiateAuth(Consumer<InitiateAuthRequest.Builder> initiateAuthRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, UnexpectedLambdaException, InvalidUserPoolConfigurationException, UserLambdaValidationException, InvalidLambdaResponseException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, InvalidSmsRoleAccessPolicyException, InvalidEmailRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, ForbiddenException, 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.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
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 Services 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.Builderavoiding the need to create one manually viaInitiateAuthRequest.builder()- Parameters:
initiateAuthRequest- AConsumerthat will call methods onInitiateAuthRequest.Builderto create a request. Initiates the authentication request.- Returns:
- Result of the InitiateAuth operation returned by the service.
- Throws:
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.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 trustcognito-idp.amazonaws.comor the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listDevices
default ListDevicesResponse listDevices(ListDevicesRequest listDevicesRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, InvalidUserPoolConfigurationException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the sign-in devices that Amazon Cognito has registered to the current user. For more information about device authentication, see Working with user devices in your user pool.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
- Parameters:
listDevicesRequest- Represents the request to list the devices.- Returns:
- Result of the ListDevices operation returned by the service.
- Throws:
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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listDevices
default ListDevicesResponse listDevices(Consumer<ListDevicesRequest.Builder> listDevicesRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, InvalidUserPoolConfigurationException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the sign-in devices that Amazon Cognito has registered to the current user. For more information about device authentication, see Working with user devices in your user pool.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
This is a convenience which creates an instance of the
ListDevicesRequest.Builderavoiding the need to create one manually viaListDevicesRequest.builder()- Parameters:
listDevicesRequest- AConsumerthat will call methods onListDevicesRequest.Builderto create a request. Represents the request to list the devices.- Returns:
- Result of the ListDevices operation returned by the service.
- Throws:
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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listGroups
default ListGroupsResponse listGroups(ListGroupsRequest listGroupsRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the groups associated with a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
listGroupsRequest-- Returns:
- Result of the ListGroups operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listGroups
default ListGroupsResponse listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the groups associated with a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
ListGroupsRequest.Builderavoiding the need to create one manually viaListGroupsRequest.builder()- Parameters:
listGroupsRequest- AConsumerthat will call methods onListGroupsRequest.Builderto create a request.- Returns:
- Result of the ListGroups operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listGroupsPaginator
default ListGroupsIterable listGroupsPaginator(ListGroupsRequest listGroupsRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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
2) Using For loopsoftware.amazon.awssdk.services.cognitoidentityprovider.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listGroupsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listGroupsPaginator
default ListGroupsIterable listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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
2) Using For loopsoftware.amazon.awssdk.services.cognitoidentityprovider.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListGroupsRequest.builder()- Parameters:
listGroupsRequest- AConsumerthat will call methods onListGroupsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listIdentityProviders
default ListIdentityProvidersResponse listIdentityProviders(ListIdentityProvidersRequest listIdentityProvidersRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists information about all IdPs for a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
listIdentityProvidersRequest-- Returns:
- Result of the ListIdentityProviders operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listIdentityProviders
default ListIdentityProvidersResponse listIdentityProviders(Consumer<ListIdentityProvidersRequest.Builder> listIdentityProvidersRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists information about all IdPs for a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
ListIdentityProvidersRequest.Builderavoiding the need to create one manually viaListIdentityProvidersRequest.builder()- Parameters:
listIdentityProvidersRequest- AConsumerthat will call methods onListIdentityProvidersRequest.Builderto create a request.- Returns:
- Result of the ListIdentityProviders operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listIdentityProvidersPaginator
default ListIdentityProvidersIterable listIdentityProvidersPaginator(ListIdentityProvidersRequest listIdentityProvidersRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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
2) Using For loopsoftware.amazon.awssdk.services.cognitoidentityprovider.paginators.ListIdentityProvidersIterable responses = client.listIdentityProvidersPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listIdentityProvidersRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listIdentityProvidersPaginator
default ListIdentityProvidersIterable listIdentityProvidersPaginator(Consumer<ListIdentityProvidersRequest.Builder> listIdentityProvidersRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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
2) Using For loopsoftware.amazon.awssdk.services.cognitoidentityprovider.paginators.ListIdentityProvidersIterable responses = client.listIdentityProvidersPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListIdentityProvidersRequest.builder()- Parameters:
listIdentityProvidersRequest- AConsumerthat will call methods onListIdentityProvidersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listResourceServers
default ListResourceServersResponse listResourceServers(ListResourceServersRequest listResourceServersRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the resource servers for a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
listResourceServersRequest-- Returns:
- Result of the ListResourceServers operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listResourceServers
default ListResourceServersResponse listResourceServers(Consumer<ListResourceServersRequest.Builder> listResourceServersRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the resource servers for a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
ListResourceServersRequest.Builderavoiding the need to create one manually viaListResourceServersRequest.builder()- Parameters:
listResourceServersRequest- AConsumerthat will call methods onListResourceServersRequest.Builderto create a request.- Returns:
- Result of the ListResourceServers operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listResourceServersPaginator
default ListResourceServersIterable listResourceServersPaginator(ListResourceServersRequest listResourceServersRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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
2) Using For loopsoftware.amazon.awssdk.services.cognitoidentityprovider.paginators.ListResourceServersIterable responses = client.listResourceServersPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listResourceServersRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listResourceServersPaginator
default ListResourceServersIterable listResourceServersPaginator(Consumer<ListResourceServersRequest.Builder> listResourceServersRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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
2) Using For loopsoftware.amazon.awssdk.services.cognitoidentityprovider.paginators.ListResourceServersIterable responses = client.listResourceServersPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListResourceServersRequest.builder()- Parameters:
listResourceServersRequest- AConsumerthat will call methods onListResourceServersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default 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.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default 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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listUserImportJobs
default ListUserImportJobsResponse listUserImportJobs(ListUserImportJobsRequest listUserImportJobsRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists user import jobs for a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
listUserImportJobsRequest- Represents the request to list the user import jobs.- Returns:
- Result of the ListUserImportJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listUserImportJobs
default ListUserImportJobsResponse listUserImportJobs(Consumer<ListUserImportJobsRequest.Builder> listUserImportJobsRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists user import jobs for a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
ListUserImportJobsRequest.Builderavoiding the need to create one manually viaListUserImportJobsRequest.builder()- Parameters:
listUserImportJobsRequest- AConsumerthat will call methods onListUserImportJobsRequest.Builderto create a request. Represents the request to list the user import jobs.- Returns:
- Result of the ListUserImportJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listUserPoolClients
default 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.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
listUserPoolClientsRequest- Represents the request to list the user pool clients.- Returns:
- Result of the ListUserPoolClients operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listUserPoolClients
default 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.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
ListUserPoolClientsRequest.Builderavoiding the need to create one manually viaListUserPoolClientsRequest.builder()- Parameters:
listUserPoolClientsRequest- AConsumerthat will call methods onListUserPoolClientsRequest.Builderto create a request. Represents the request to list the user pool clients.- Returns:
- Result of the ListUserPoolClients operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listUserPoolClientsPaginator
default ListUserPoolClientsIterable listUserPoolClientsPaginator(ListUserPoolClientsRequest listUserPoolClientsRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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
2) Using For loopsoftware.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUserPoolClientsIterable responses = client.listUserPoolClientsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listUserPoolClientsRequest- Represents the request to list the user pool clients.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listUserPoolClientsPaginator
default ListUserPoolClientsIterable listUserPoolClientsPaginator(Consumer<ListUserPoolClientsRequest.Builder> listUserPoolClientsRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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
2) Using For loopsoftware.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUserPoolClientsIterable responses = client.listUserPoolClientsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListUserPoolClientsRequest.builder()- Parameters:
listUserPoolClientsRequest- AConsumerthat will call methods onListUserPoolClientsRequest.Builderto create a request. Represents the request to list the user pool clients.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listUserPools
default ListUserPoolsResponse listUserPools(ListUserPoolsRequest listUserPoolsRequest) throws InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the user pools associated with an Amazon Web Services account.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
listUserPoolsRequest- Represents the request to list user pools.- Returns:
- Result of the ListUserPools operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listUserPools
default 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.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
ListUserPoolsRequest.Builderavoiding the need to create one manually viaListUserPoolsRequest.builder()- Parameters:
listUserPoolsRequest- AConsumerthat will call methods onListUserPoolsRequest.Builderto create a request. Represents the request to list user pools.- Returns:
- Result of the ListUserPools operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listUserPoolsPaginator
default ListUserPoolsIterable listUserPoolsPaginator(ListUserPoolsRequest listUserPoolsRequest) throws InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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
2) Using For loopsoftware.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUserPoolsIterable responses = client.listUserPoolsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listUserPoolsRequest- Represents the request to list user pools.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listUserPoolsPaginator
default ListUserPoolsIterable listUserPoolsPaginator(Consumer<ListUserPoolsRequest.Builder> listUserPoolsRequest) throws InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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
2) Using For loopsoftware.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUserPoolsIterable responses = client.listUserPoolsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListUserPoolsRequest.builder()- Parameters:
listUserPoolsRequest- AConsumerthat will call methods onListUserPoolsRequest.Builderto create a request. Represents the request to list user pools.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listUsers
default ListUsersResponse listUsers(ListUsersRequest listUsersRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists users and their basic details in a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
listUsersRequest- Represents the request to list users.- Returns:
- Result of the ListUsers operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listUsers
default ListUsersResponse listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists users and their basic details in a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
ListUsersRequest.Builderavoiding the need to create one manually viaListUsersRequest.builder()- Parameters:
listUsersRequest- AConsumerthat will call methods onListUsersRequest.Builderto create a request. Represents the request to list users.- Returns:
- Result of the ListUsers operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listUsersPaginator
default ListUsersIterable listUsersPaginator(ListUsersRequest listUsersRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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
2) Using For loopsoftware.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listUsersRequest- Represents the request to list users.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listUsersPaginator
default ListUsersIterable listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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
2) Using For loopsoftware.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListUsersRequest.builder()- Parameters:
listUsersRequest- AConsumerthat will call methods onListUsersRequest.Builderto create a request. Represents the request to list users.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listUsersInGroup
default ListUsersInGroupResponse listUsersInGroup(ListUsersInGroupRequest listUsersInGroupRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the users in the specified group.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
listUsersInGroupRequest-- Returns:
- Result of the ListUsersInGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listUsersInGroup
default ListUsersInGroupResponse listUsersInGroup(Consumer<ListUsersInGroupRequest.Builder> listUsersInGroupRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Lists the users in the specified group.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
ListUsersInGroupRequest.Builderavoiding the need to create one manually viaListUsersInGroupRequest.builder()- Parameters:
listUsersInGroupRequest- AConsumerthat will call methods onListUsersInGroupRequest.Builderto create a request.- Returns:
- Result of the ListUsersInGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listUsersInGroupPaginator
default ListUsersInGroupIterable listUsersInGroupPaginator(ListUsersInGroupRequest listUsersInGroupRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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
2) Using For loopsoftware.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUsersInGroupIterable responses = client.listUsersInGroupPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listUsersInGroupRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listUsersInGroupPaginator
default ListUsersInGroupIterable listUsersInGroupPaginator(Consumer<ListUsersInGroupRequest.Builder> listUsersInGroupRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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
2) Using For loopsoftware.amazon.awssdk.services.cognitoidentityprovider.paginators.ListUsersInGroupIterable responses = client.listUsersInGroupPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListUsersInGroupRequest.builder()- Parameters:
listUsersInGroupRequest- AConsumerthat will call methods onListUsersInGroupRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listWebAuthnCredentials
default ListWebAuthnCredentialsResponse listWebAuthnCredentials(ListWebAuthnCredentialsRequest listWebAuthnCredentialsRequest) throws ForbiddenException, InternalErrorException, InvalidParameterException, NotAuthorizedException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Generates a list of the current user's registered passkey, or webauthN, credentials.
- Parameters:
listWebAuthnCredentialsRequest-- Returns:
- Result of the ListWebAuthnCredentials operation returned by the service.
- Throws:
ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.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.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.AwsServiceException- See Also:
- AWS API Documentation
-
listWebAuthnCredentials
default ListWebAuthnCredentialsResponse listWebAuthnCredentials(Consumer<ListWebAuthnCredentialsRequest.Builder> listWebAuthnCredentialsRequest) throws ForbiddenException, InternalErrorException, InvalidParameterException, NotAuthorizedException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Generates a list of the current user's registered passkey, or webauthN, credentials.
This is a convenience which creates an instance of the
ListWebAuthnCredentialsRequest.Builderavoiding the need to create one manually viaListWebAuthnCredentialsRequest.builder()- Parameters:
listWebAuthnCredentialsRequest- AConsumerthat will call methods onListWebAuthnCredentialsRequest.Builderto create a request.- Returns:
- Result of the ListWebAuthnCredentials operation returned by the service.
- Throws:
ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.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.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.AwsServiceException- See Also:
- AWS API Documentation
-
resendConfirmationCode
default ResendConfirmationCodeResponse resendConfirmationCode(ResendConfirmationCodeRequest resendConfirmationCodeRequest) throws ResourceNotFoundException, InvalidParameterException, UnexpectedLambdaException, UserLambdaValidationException, NotAuthorizedException, InvalidLambdaResponseException, TooManyRequestsException, LimitExceededException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InvalidEmailRoleAccessPolicyException, CodeDeliveryFailureException, UserNotFoundException, InternalErrorException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
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 Services 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.
- Parameters:
resendConfirmationCodeRequest- Represents the request to resend the confirmation code.- Returns:
- Result of the ResendConfirmationCode operation returned by the service.
- Throws:
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 trustcognito-idp.amazonaws.comor 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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
resendConfirmationCode
default ResendConfirmationCodeResponse resendConfirmationCode(Consumer<ResendConfirmationCodeRequest.Builder> resendConfirmationCodeRequest) throws ResourceNotFoundException, InvalidParameterException, UnexpectedLambdaException, UserLambdaValidationException, NotAuthorizedException, InvalidLambdaResponseException, TooManyRequestsException, LimitExceededException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InvalidEmailRoleAccessPolicyException, CodeDeliveryFailureException, UserNotFoundException, InternalErrorException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
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 Services 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.Builderavoiding the need to create one manually viaResendConfirmationCodeRequest.builder()- Parameters:
resendConfirmationCodeRequest- AConsumerthat will call methods onResendConfirmationCodeRequest.Builderto create a request. Represents the request to resend the confirmation code.- Returns:
- Result of the ResendConfirmationCode operation returned by the service.
- Throws:
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 trustcognito-idp.amazonaws.comor 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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
respondToAuthChallenge
default RespondToAuthChallengeResponse respondToAuthChallenge(RespondToAuthChallengeRequest respondToAuthChallengeRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, CodeMismatchException, ExpiredCodeException, UnexpectedLambdaException, UserLambdaValidationException, InvalidPasswordException, PasswordHistoryPolicyViolationException, InvalidLambdaResponseException, TooManyRequestsException, InvalidUserPoolConfigurationException, MfaMethodNotFoundException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InvalidEmailRoleAccessPolicyException, AliasExistsException, InternalErrorException, SoftwareTokenMfaNotFoundException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Some API operations in a user pool generate a challenge, like a prompt for an MFA code, for device authentication that bypasses MFA, or for a custom authentication challenge. A
RespondToAuthChallengeAPI request provides the answer to that challenge, like a code or a secure remote password (SRP). The parameters of a response to an authentication challenge vary with the type of challenge.For more information about custom authentication challenges, see Custom authentication challenge Lambda triggers.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
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 Services 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.
- Parameters:
respondToAuthChallengeRequest- The request to respond to an authentication challenge.- Returns:
- Result of the RespondToAuthChallenge operation returned by the service.
- Throws:
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.PasswordHistoryPolicyViolationException- The message returned when a user's new password matches a previous password and doesn't comply with the password-history policy.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 trustcognito-idp.amazonaws.comor 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.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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
respondToAuthChallenge
default RespondToAuthChallengeResponse respondToAuthChallenge(Consumer<RespondToAuthChallengeRequest.Builder> respondToAuthChallengeRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, CodeMismatchException, ExpiredCodeException, UnexpectedLambdaException, UserLambdaValidationException, InvalidPasswordException, PasswordHistoryPolicyViolationException, InvalidLambdaResponseException, TooManyRequestsException, InvalidUserPoolConfigurationException, MfaMethodNotFoundException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InvalidEmailRoleAccessPolicyException, AliasExistsException, InternalErrorException, SoftwareTokenMfaNotFoundException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Some API operations in a user pool generate a challenge, like a prompt for an MFA code, for device authentication that bypasses MFA, or for a custom authentication challenge. A
RespondToAuthChallengeAPI request provides the answer to that challenge, like a code or a secure remote password (SRP). The parameters of a response to an authentication challenge vary with the type of challenge.For more information about custom authentication challenges, see Custom authentication challenge Lambda triggers.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
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 Services 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.Builderavoiding the need to create one manually viaRespondToAuthChallengeRequest.builder()- Parameters:
respondToAuthChallengeRequest- AConsumerthat will call methods onRespondToAuthChallengeRequest.Builderto create a request. The request to respond to an authentication challenge.- Returns:
- Result of the RespondToAuthChallenge operation returned by the service.
- Throws:
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.PasswordHistoryPolicyViolationException- The message returned when a user's new password matches a previous password and doesn't comply with the password-history policy.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 trustcognito-idp.amazonaws.comor 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.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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
revokeToken
default RevokeTokenResponse revokeToken(RevokeTokenRequest revokeTokenRequest) throws TooManyRequestsException, InternalErrorException, UnauthorizedException, InvalidParameterException, UnsupportedOperationException, UnsupportedTokenTypeException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Revokes all of the access tokens generated by, and at the same time as, the specified refresh token. After a token is revoked, you can't use the revoked token to access Amazon Cognito user APIs, or to authorize access to your resource server.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
- Parameters:
revokeTokenRequest-- Returns:
- Result of the RevokeToken operation returned by the service.
- Throws:
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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your 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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
revokeToken
default RevokeTokenResponse revokeToken(Consumer<RevokeTokenRequest.Builder> revokeTokenRequest) throws TooManyRequestsException, InternalErrorException, UnauthorizedException, InvalidParameterException, UnsupportedOperationException, UnsupportedTokenTypeException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Revokes all of the access tokens generated by, and at the same time as, the specified refresh token. After a token is revoked, you can't use the revoked token to access Amazon Cognito user APIs, or to authorize access to your resource server.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
This is a convenience which creates an instance of the
RevokeTokenRequest.Builderavoiding the need to create one manually viaRevokeTokenRequest.builder()- Parameters:
revokeTokenRequest- AConsumerthat will call methods onRevokeTokenRequest.Builderto create a request.- Returns:
- Result of the RevokeToken operation returned by the service.
- Throws:
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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your 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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
setLogDeliveryConfiguration
default SetLogDeliveryConfigurationResponse setLogDeliveryConfiguration(SetLogDeliveryConfigurationRequest setLogDeliveryConfigurationRequest) throws InvalidParameterException, InternalErrorException, TooManyRequestsException, NotAuthorizedException, ResourceNotFoundException, FeatureUnavailableInTierException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Sets up or modifies the logging configuration of a user pool. User pools can export user notification logs and advanced security features user activity logs.
- Parameters:
setLogDeliveryConfigurationRequest-- Returns:
- Result of the SetLogDeliveryConfiguration operation returned by the service.
- Throws:
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.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.ResourceNotFoundException- This exception is thrown when the Amazon Cognito service can't find the requested resource.FeatureUnavailableInTierException- This exception is thrown when a feature you attempted to configure isn't available in your current feature plan.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
setLogDeliveryConfiguration
default SetLogDeliveryConfigurationResponse setLogDeliveryConfiguration(Consumer<SetLogDeliveryConfigurationRequest.Builder> setLogDeliveryConfigurationRequest) throws InvalidParameterException, InternalErrorException, TooManyRequestsException, NotAuthorizedException, ResourceNotFoundException, FeatureUnavailableInTierException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Sets up or modifies the logging configuration of a user pool. User pools can export user notification logs and advanced security features user activity logs.
This is a convenience which creates an instance of the
SetLogDeliveryConfigurationRequest.Builderavoiding the need to create one manually viaSetLogDeliveryConfigurationRequest.builder()- Parameters:
setLogDeliveryConfigurationRequest- AConsumerthat will call methods onSetLogDeliveryConfigurationRequest.Builderto create a request.- Returns:
- Result of the SetLogDeliveryConfiguration operation returned by the service.
- Throws:
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.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.ResourceNotFoundException- This exception is thrown when the Amazon Cognito service can't find the requested resource.FeatureUnavailableInTierException- This exception is thrown when a feature you attempted to configure isn't available in your current feature plan.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
setRiskConfiguration
default 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
UserPoolIdorClientId, pass null values for all four configuration types.To activate Amazon Cognito advanced security features, update the user pool to include the
UserPoolAddOnskeyAdvancedSecurityMode.- Parameters:
setRiskConfigurationRequest-- Returns:
- Result of the SetRiskConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
setRiskConfiguration
default 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
UserPoolIdorClientId, pass null values for all four configuration types.To activate Amazon Cognito advanced security features, update the user pool to include the
UserPoolAddOnskeyAdvancedSecurityMode.
This is a convenience which creates an instance of the
SetRiskConfigurationRequest.Builderavoiding the need to create one manually viaSetRiskConfigurationRequest.builder()- Parameters:
setRiskConfigurationRequest- AConsumerthat will call methods onSetRiskConfigurationRequest.Builderto create a request.- Returns:
- Result of the SetRiskConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
setUICustomization
default 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 theclientIdtoALL). If you specifyALL, 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 theALLconfiguration.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.
- Parameters:
setUiCustomizationRequest-- Returns:
- Result of the SetUICustomization operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
setUICustomization
default 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 theclientIdtoALL). If you specifyALL, 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 theALLconfiguration.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.Builderavoiding the need to create one manually viaSetUiCustomizationRequest.builder()- Parameters:
setUiCustomizationRequest- AConsumerthat will call methods onSetUiCustomizationRequest.Builderto create a request.- Returns:
- Result of the SetUICustomization operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
setUserMFAPreference
default SetUserMfaPreferenceResponse setUserMFAPreference(SetUserMfaPreferenceRequest setUserMfaPreferenceRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, ForbiddenException, 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 operation doesn't reset an existing TOTP MFA for a user. To register a new TOTP factor for a user, make an AssociateSoftwareToken request. For more information, see TOTP software token MFA.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
- Parameters:
setUserMfaPreferenceRequest-- Returns:
- Result of the SetUserMFAPreference operation returned by the service.
- Throws:
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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
setUserMFAPreference
default SetUserMfaPreferenceResponse setUserMFAPreference(Consumer<SetUserMfaPreferenceRequest.Builder> setUserMfaPreferenceRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, ForbiddenException, 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 operation doesn't reset an existing TOTP MFA for a user. To register a new TOTP factor for a user, make an AssociateSoftwareToken request. For more information, see TOTP software token MFA.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
This is a convenience which creates an instance of the
SetUserMfaPreferenceRequest.Builderavoiding the need to create one manually viaSetUserMfaPreferenceRequest.builder()- Parameters:
setUserMfaPreferenceRequest- AConsumerthat will call methods onSetUserMfaPreferenceRequest.Builderto create a request.- Returns:
- Result of the SetUserMFAPreference operation returned by the service.
- Throws:
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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
setUserPoolMfaConfig
default SetUserPoolMfaConfigResponse setUserPoolMfaConfig(SetUserPoolMfaConfigRequest setUserPoolMfaConfigRequest) throws InvalidParameterException, TooManyRequestsException, ConcurrentModificationException, ResourceNotFoundException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, NotAuthorizedException, InternalErrorException, FeatureUnavailableInTierException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Sets the user pool multi-factor authentication (MFA) and passkey 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 Services 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.
- Parameters:
setUserPoolMfaConfigRequest-- Returns:
- Result of the SetUserPoolMfaConfig operation returned by the service.
- Throws:
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.ConcurrentModificationException- This exception is thrown if two or more modifications are happening concurrently.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 trustcognito-idp.amazonaws.comor 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.FeatureUnavailableInTierException- This exception is thrown when a feature you attempted to configure isn't available in your current feature plan.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
setUserPoolMfaConfig
default SetUserPoolMfaConfigResponse setUserPoolMfaConfig(Consumer<SetUserPoolMfaConfigRequest.Builder> setUserPoolMfaConfigRequest) throws InvalidParameterException, TooManyRequestsException, ConcurrentModificationException, ResourceNotFoundException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, NotAuthorizedException, InternalErrorException, FeatureUnavailableInTierException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Sets the user pool multi-factor authentication (MFA) and passkey 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 Services 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.Builderavoiding the need to create one manually viaSetUserPoolMfaConfigRequest.builder()- Parameters:
setUserPoolMfaConfigRequest- AConsumerthat will call methods onSetUserPoolMfaConfigRequest.Builderto create a request.- Returns:
- Result of the SetUserPoolMfaConfig operation returned by the service.
- Throws:
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.ConcurrentModificationException- This exception is thrown if two or more modifications are happening concurrently.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 trustcognito-idp.amazonaws.comor 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.FeatureUnavailableInTierException- This exception is thrown when a feature you attempted to configure isn't available in your current feature plan.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
setUserSettings
default SetUserSettingsResponse setUserSettings(SetUserSettingsRequest setUserSettingsRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, ForbiddenException, 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.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
- Parameters:
setUserSettingsRequest- Represents the request to set user settings.- Returns:
- Result of the SetUserSettings operation returned by the service.
- Throws:
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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
setUserSettings
default SetUserSettingsResponse setUserSettings(Consumer<SetUserSettingsRequest.Builder> setUserSettingsRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, ForbiddenException, 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.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
This is a convenience which creates an instance of the
SetUserSettingsRequest.Builderavoiding the need to create one manually viaSetUserSettingsRequest.builder()- Parameters:
setUserSettingsRequest- AConsumerthat will call methods onSetUserSettingsRequest.Builderto create a request. Represents the request to set user settings.- Returns:
- Result of the SetUserSettings operation returned by the service.
- Throws:
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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
signUp
default SignUpResponse signUp(SignUpRequest signUpRequest) throws ResourceNotFoundException, InvalidParameterException, UnexpectedLambdaException, UserLambdaValidationException, NotAuthorizedException, InvalidPasswordException, InvalidLambdaResponseException, UsernameExistsException, TooManyRequestsException, InternalErrorException, LimitExceededException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InvalidEmailRoleAccessPolicyException, CodeDeliveryFailureException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Registers the user in the specified user pool and creates a user name, password, and user attributes.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
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 Services 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.
You might receive a
LimitExceededexception in response to this request if you have exceeded a rate quota for email or SMS messages, and if your user pool automatically verifies email addresses or phone numbers. When you get this exception in the response, the user is successfully created and is in anUNCONFIRMEDstate. You can send a new code with the ResendConfirmationCode request, or confirm the user as an administrator with an AdminConfirmSignUp request.- Parameters:
signUpRequest- Represents the request to register a user.- Returns:
- Result of the SignUp operation returned by the service.
- Throws:
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.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 trustcognito-idp.amazonaws.comor 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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
signUp
default SignUpResponse signUp(Consumer<SignUpRequest.Builder> signUpRequest) throws ResourceNotFoundException, InvalidParameterException, UnexpectedLambdaException, UserLambdaValidationException, NotAuthorizedException, InvalidPasswordException, InvalidLambdaResponseException, UsernameExistsException, TooManyRequestsException, InternalErrorException, LimitExceededException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InvalidEmailRoleAccessPolicyException, CodeDeliveryFailureException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Registers the user in the specified user pool and creates a user name, password, and user attributes.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
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 Services 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.
You might receive a
LimitExceededexception in response to this request if you have exceeded a rate quota for email or SMS messages, and if your user pool automatically verifies email addresses or phone numbers. When you get this exception in the response, the user is successfully created and is in anUNCONFIRMEDstate. You can send a new code with the ResendConfirmationCode request, or confirm the user as an administrator with an AdminConfirmSignUp request.
This is a convenience which creates an instance of the
SignUpRequest.Builderavoiding the need to create one manually viaSignUpRequest.builder()- Parameters:
signUpRequest- AConsumerthat will call methods onSignUpRequest.Builderto create a request. Represents the request to register a user.- Returns:
- Result of the SignUp operation returned by the service.
- Throws:
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.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 trustcognito-idp.amazonaws.comor 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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startUserImportJob
default StartUserImportJobResponse startUserImportJob(StartUserImportJobRequest startUserImportJobRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, InternalErrorException, PreconditionNotMetException, NotAuthorizedException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Starts the user import.
- Parameters:
startUserImportJobRequest- Represents the request to start the user import job.- Returns:
- Result of the StartUserImportJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startUserImportJob
default 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.Builderavoiding the need to create one manually viaStartUserImportJobRequest.builder()- Parameters:
startUserImportJobRequest- AConsumerthat will call methods onStartUserImportJobRequest.Builderto create a request. Represents the request to start the user import job.- Returns:
- Result of the StartUserImportJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startWebAuthnRegistration
default StartWebAuthnRegistrationResponse startWebAuthnRegistration(StartWebAuthnRegistrationRequest startWebAuthnRegistrationRequest) throws ForbiddenException, InternalErrorException, InvalidParameterException, LimitExceededException, NotAuthorizedException, TooManyRequestsException, WebAuthnNotEnabledException, WebAuthnConfigurationMissingException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Requests credential creation options from your user pool for registration of a passkey authenticator. Returns information about the user pool, the user profile, and authentication requirements. Users must provide this information in their request to enroll your application with their passkey provider.
After users present this data and register with their passkey provider, return the response to your user pool in a CompleteWebAuthnRegistration API request.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.- Parameters:
startWebAuthnRegistrationRequest-- Returns:
- Result of the StartWebAuthnRegistration operation returned by the service.
- Throws:
ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.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.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.TooManyRequestsException- This exception is thrown when the user has made too many requests for a given operation.WebAuthnNotEnabledException- This exception is thrown when the passkey feature isn't enabled for the user pool.WebAuthnConfigurationMissingException- This exception is thrown when a user pool doesn't have a configured relying party id or a user pool domain.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startWebAuthnRegistration
default StartWebAuthnRegistrationResponse startWebAuthnRegistration(Consumer<StartWebAuthnRegistrationRequest.Builder> startWebAuthnRegistrationRequest) throws ForbiddenException, InternalErrorException, InvalidParameterException, LimitExceededException, NotAuthorizedException, TooManyRequestsException, WebAuthnNotEnabledException, WebAuthnConfigurationMissingException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Requests credential creation options from your user pool for registration of a passkey authenticator. Returns information about the user pool, the user profile, and authentication requirements. Users must provide this information in their request to enroll your application with their passkey provider.
After users present this data and register with their passkey provider, return the response to your user pool in a CompleteWebAuthnRegistration API request.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.
This is a convenience which creates an instance of the
StartWebAuthnRegistrationRequest.Builderavoiding the need to create one manually viaStartWebAuthnRegistrationRequest.builder()- Parameters:
startWebAuthnRegistrationRequest- AConsumerthat will call methods onStartWebAuthnRegistrationRequest.Builderto create a request.- Returns:
- Result of the StartWebAuthnRegistration operation returned by the service.
- Throws:
ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.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.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.TooManyRequestsException- This exception is thrown when the user has made too many requests for a given operation.WebAuthnNotEnabledException- This exception is thrown when the passkey feature isn't enabled for the user pool.WebAuthnConfigurationMissingException- This exception is thrown when a user pool doesn't have a configured relying party id or a user pool domain.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
stopUserImportJob
default StopUserImportJobResponse stopUserImportJob(StopUserImportJobRequest stopUserImportJobRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, InternalErrorException, PreconditionNotMetException, NotAuthorizedException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Stops the user import job.
- Parameters:
stopUserImportJobRequest- Represents the request to stop the user import job.- Returns:
- Result of the StopUserImportJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
stopUserImportJob
default 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.Builderavoiding the need to create one manually viaStopUserImportJobRequest.builder()- Parameters:
stopUserImportJobRequest- AConsumerthat will call methods onStopUserImportJobRequest.Builderto create a request. Represents the request to stop the user import job.- Returns:
- Result of the StopUserImportJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default 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
Environmenttag key to both user pools. The value of this key might beTestfor one user pool, andProductionfor 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.
- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default 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
Environmenttag key to both user pools. The value of this key might beTestfor one user pool, andProductionfor 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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default 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.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default 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.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateAuthEventFeedback
default 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.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
- Parameters:
updateAuthEventFeedbackRequest-- Returns:
- Result of the UpdateAuthEventFeedback operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateAuthEventFeedback
default 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.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
This is a convenience which creates an instance of the
UpdateAuthEventFeedbackRequest.Builderavoiding the need to create one manually viaUpdateAuthEventFeedbackRequest.builder()- Parameters:
updateAuthEventFeedbackRequest- AConsumerthat will call methods onUpdateAuthEventFeedbackRequest.Builderto create a request.- Returns:
- Result of the UpdateAuthEventFeedback operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateDeviceStatus
default UpdateDeviceStatusResponse updateDeviceStatus(UpdateDeviceStatusRequest updateDeviceStatusRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, InvalidUserPoolConfigurationException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Updates the device status. For more information about device authentication, see Working with user devices in your user pool.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
- Parameters:
updateDeviceStatusRequest- Represents the request to update the device status.- Returns:
- Result of the UpdateDeviceStatus operation returned by the service.
- Throws:
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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateDeviceStatus
default UpdateDeviceStatusResponse updateDeviceStatus(Consumer<UpdateDeviceStatusRequest.Builder> updateDeviceStatusRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, InvalidUserPoolConfigurationException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Updates the device status. For more information about device authentication, see Working with user devices in your user pool.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
This is a convenience which creates an instance of the
UpdateDeviceStatusRequest.Builderavoiding the need to create one manually viaUpdateDeviceStatusRequest.builder()- Parameters:
updateDeviceStatusRequest- AConsumerthat will call methods onUpdateDeviceStatusRequest.Builderto create a request. Represents the request to update the device status.- Returns:
- Result of the UpdateDeviceStatus operation returned by the service.
- Throws:
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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateGroup
default UpdateGroupResponse updateGroup(UpdateGroupRequest updateGroupRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Updates the specified group with the specified attributes.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
updateGroupRequest-- Returns:
- Result of the UpdateGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateGroup
default UpdateGroupResponse updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Updates the specified group with the specified attributes.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
UpdateGroupRequest.Builderavoiding the need to create one manually viaUpdateGroupRequest.builder()- Parameters:
updateGroupRequest- AConsumerthat will call methods onUpdateGroupRequest.Builderto create a request.- Returns:
- Result of the UpdateGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateIdentityProvider
default UpdateIdentityProviderResponse updateIdentityProvider(UpdateIdentityProviderRequest updateIdentityProviderRequest) throws InvalidParameterException, UnsupportedIdentityProviderException, ResourceNotFoundException, ConcurrentModificationException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Updates IdP information for a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
updateIdentityProviderRequest-- Returns:
- Result of the UpdateIdentityProvider operation returned by the service.
- Throws:
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.ConcurrentModificationException- This exception is thrown if two or more modifications are happening concurrently.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateIdentityProvider
default UpdateIdentityProviderResponse updateIdentityProvider(Consumer<UpdateIdentityProviderRequest.Builder> updateIdentityProviderRequest) throws InvalidParameterException, UnsupportedIdentityProviderException, ResourceNotFoundException, ConcurrentModificationException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Updates IdP information for a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
UpdateIdentityProviderRequest.Builderavoiding the need to create one manually viaUpdateIdentityProviderRequest.builder()- Parameters:
updateIdentityProviderRequest- AConsumerthat will call methods onUpdateIdentityProviderRequest.Builderto create a request.- Returns:
- Result of the UpdateIdentityProvider operation returned by the service.
- Throws:
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.ConcurrentModificationException- This exception is thrown if two or more modifications are happening concurrently.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateManagedLoginBranding
default UpdateManagedLoginBrandingResponse updateManagedLoginBranding(UpdateManagedLoginBrandingRequest updateManagedLoginBrandingRequest) throws ResourceNotFoundException, ConcurrentModificationException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Configures the branding settings for a user pool style. This operation is the programmatic option for the configuration of a style in the branding designer.
Provides values for UI customization in a
SettingsJSON object and image files in anAssetsarray.This operation has a 2-megabyte request-size limit and include the CSS settings and image assets for your app client. Your branding settings might exceed 2MB in size. Amazon Cognito doesn't require that you pass all parameters in one request and preserves existing style settings that you don't specify. If your request is larger than 2MB, separate it into multiple requests, each with a size smaller than the limit.
As a best practice, modify the output of DescribeManagedLoginBrandingByClient into the request parameters for this operation. To get all settings, set
ReturnMergedResourcestotrue. For more information, see API and SDK operations for managed login brandingAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
updateManagedLoginBrandingRequest-- Returns:
- Result of the UpdateManagedLoginBranding operation returned by the service.
- Throws:
ResourceNotFoundException- This exception is thrown when the Amazon Cognito service can't find the requested resource.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.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateManagedLoginBranding
default UpdateManagedLoginBrandingResponse updateManagedLoginBranding(Consumer<UpdateManagedLoginBrandingRequest.Builder> updateManagedLoginBrandingRequest) throws ResourceNotFoundException, ConcurrentModificationException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
Configures the branding settings for a user pool style. This operation is the programmatic option for the configuration of a style in the branding designer.
Provides values for UI customization in a
SettingsJSON object and image files in anAssetsarray.This operation has a 2-megabyte request-size limit and include the CSS settings and image assets for your app client. Your branding settings might exceed 2MB in size. Amazon Cognito doesn't require that you pass all parameters in one request and preserves existing style settings that you don't specify. If your request is larger than 2MB, separate it into multiple requests, each with a size smaller than the limit.
As a best practice, modify the output of DescribeManagedLoginBrandingByClient into the request parameters for this operation. To get all settings, set
ReturnMergedResourcestotrue. For more information, see API and SDK operations for managed login brandingAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
UpdateManagedLoginBrandingRequest.Builderavoiding the need to create one manually viaUpdateManagedLoginBrandingRequest.builder()- Parameters:
updateManagedLoginBrandingRequest- AConsumerthat will call methods onUpdateManagedLoginBrandingRequest.Builderto create a request.- Returns:
- Result of the UpdateManagedLoginBranding operation returned by the service.
- Throws:
ResourceNotFoundException- This exception is thrown when the Amazon Cognito service can't find the requested resource.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.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateResourceServer
default 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.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
updateResourceServerRequest-- Returns:
- Result of the UpdateResourceServer operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateResourceServer
default 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.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
UpdateResourceServerRequest.Builderavoiding the need to create one manually viaUpdateResourceServerRequest.builder()- Parameters:
updateResourceServerRequest- AConsumerthat will call methods onUpdateResourceServerRequest.Builderto create a request.- Returns:
- Result of the UpdateResourceServer operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateUserAttributes
default UpdateUserAttributesResponse updateUserAttributes(UpdateUserAttributesRequest updateUserAttributesRequest) throws ResourceNotFoundException, InvalidParameterException, CodeMismatchException, ExpiredCodeException, NotAuthorizedException, UnexpectedLambdaException, UserLambdaValidationException, InvalidLambdaResponseException, TooManyRequestsException, AliasExistsException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InvalidEmailRoleAccessPolicyException, CodeDeliveryFailureException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
With this operation, your users can update one or more of their attributes with their own credentials. You authorize this API request with the user's access token. To delete an attribute from your user, submit the attribute in your API request with a blank value. Custom attribute values in this request must include the
custom:prefix.Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
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 Services 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.
- Parameters:
updateUserAttributesRequest- Represents the request to update user attributes.- Returns:
- Result of the UpdateUserAttributes operation returned by the service.
- Throws:
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 trustcognito-idp.amazonaws.comor 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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateUserAttributes
default 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, ForbiddenException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
With this operation, your users can update one or more of their attributes with their own credentials. You authorize this API request with the user's access token. To delete an attribute from your user, submit the attribute in your API request with a blank value. Custom attribute values in this request must include the
custom:prefix.Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
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 Services 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.Builderavoiding the need to create one manually viaUpdateUserAttributesRequest.builder()- Parameters:
updateUserAttributesRequest- AConsumerthat will call methods onUpdateUserAttributesRequest.Builderto create a request. Represents the request to update user attributes.- Returns:
- Result of the UpdateUserAttributes operation returned by the service.
- Throws:
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 trustcognito-idp.amazonaws.comor 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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateUserPool
default UpdateUserPoolResponse updateUserPool(UpdateUserPoolRequest updateUserPoolRequest) throws ResourceNotFoundException, InvalidParameterException, ConcurrentModificationException, TooManyRequestsException, NotAuthorizedException, UserImportInProgressException, InternalErrorException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, UserPoolTaggingException, InvalidEmailRoleAccessPolicyException, TierChangeNotAllowedException, FeatureUnavailableInTierException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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 Services 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.
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, Amazon Cognito sets it to its default value.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
updateUserPoolRequest- Represents the request to update the user pool.- Returns:
- Result of the UpdateUserPool operation returned by the service.
- Throws:
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 trustcognito-idp.amazonaws.comor 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.TierChangeNotAllowedException- This exception is thrown when you've attempted to change your feature plan but the operation isn't permitted.FeatureUnavailableInTierException- This exception is thrown when a feature you attempted to configure isn't available in your current feature plan.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateUserPool
default UpdateUserPoolResponse updateUserPool(Consumer<UpdateUserPoolRequest.Builder> updateUserPoolRequest) throws ResourceNotFoundException, InvalidParameterException, ConcurrentModificationException, TooManyRequestsException, NotAuthorizedException, UserImportInProgressException, InternalErrorException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, UserPoolTaggingException, InvalidEmailRoleAccessPolicyException, TierChangeNotAllowedException, FeatureUnavailableInTierException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
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 Services 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.
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, Amazon Cognito sets it to its default value.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
UpdateUserPoolRequest.Builderavoiding the need to create one manually viaUpdateUserPoolRequest.builder()- Parameters:
updateUserPoolRequest- AConsumerthat will call methods onUpdateUserPoolRequest.Builderto create a request. Represents the request to update the user pool.- Returns:
- Result of the UpdateUserPool operation returned by the service.
- Throws:
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 trustcognito-idp.amazonaws.comor 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.TierChangeNotAllowedException- This exception is thrown when you've attempted to change your feature plan but the operation isn't permitted.FeatureUnavailableInTierException- This exception is thrown when a feature you attempted to configure isn't available in your current feature plan.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateUserPoolClient
default 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, Amazon Cognito sets it to its default value.
You can also use this operation to enable token revocation for user pool clients. For more information about revoking tokens, see RevokeToken.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
updateUserPoolClientRequest- Represents the request to update the user pool client.- Returns:
- Result of the UpdateUserPoolClient operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateUserPoolClient
default 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, Amazon Cognito sets it to its default value.
You can also use this operation to enable token revocation for user pool clients. For more information about revoking tokens, see RevokeToken.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
UpdateUserPoolClientRequest.Builderavoiding the need to create one manually viaUpdateUserPoolClientRequest.builder()- Parameters:
updateUserPoolClientRequest- AConsumerthat will call methods onUpdateUserPoolClientRequest.Builderto create a request. Represents the request to update the user pool client.- Returns:
- Result of the UpdateUserPoolClient operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateUserPoolDomain
default UpdateUserPoolDomainResponse updateUserPoolDomain(UpdateUserPoolDomainRequest updateUserPoolDomainRequest) throws InvalidParameterException, NotAuthorizedException, ResourceNotFoundException, TooManyRequestsException, InternalErrorException, FeatureUnavailableInTierException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
A user pool domain hosts managed login, an authorization server and web server for authentication in your application. This operation updates the branding version for user pool domains between
1for hosted UI (classic) and2for managed login. It also updates the SSL certificate for user pool custom domains.Changes to the domain branding version take up to one minute to take effect for a prefix domain and up to five minutes for a custom domain.
This operation doesn't change the name of your user pool domain. To change your domain, delete it with
DeleteUserPoolDomainand create a new domain withCreateUserPoolDomain.You can pass the ARN of a new Certificate Manager certificate in this request. Typically, ACM certificates automatically renew and you user pool can continue to use the same ARN. But if you generate a new certificate for your custom domain name, replace the original configuration with the new ARN in this request.
ACM certificates for custom domains must be in the US East (N. Virginia) 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 Configuring a user pool domain.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
- Parameters:
updateUserPoolDomainRequest- The UpdateUserPoolDomain request input.- Returns:
- Result of the UpdateUserPoolDomain operation returned by the service.
- Throws:
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.FeatureUnavailableInTierException- This exception is thrown when a feature you attempted to configure isn't available in your current feature plan.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateUserPoolDomain
default UpdateUserPoolDomainResponse updateUserPoolDomain(Consumer<UpdateUserPoolDomainRequest.Builder> updateUserPoolDomainRequest) throws InvalidParameterException, NotAuthorizedException, ResourceNotFoundException, TooManyRequestsException, InternalErrorException, FeatureUnavailableInTierException, AwsServiceException, SdkClientException, CognitoIdentityProviderException
A user pool domain hosts managed login, an authorization server and web server for authentication in your application. This operation updates the branding version for user pool domains between
1for hosted UI (classic) and2for managed login. It also updates the SSL certificate for user pool custom domains.Changes to the domain branding version take up to one minute to take effect for a prefix domain and up to five minutes for a custom domain.
This operation doesn't change the name of your user pool domain. To change your domain, delete it with
DeleteUserPoolDomainand create a new domain withCreateUserPoolDomain.You can pass the ARN of a new Certificate Manager certificate in this request. Typically, ACM certificates automatically renew and you user pool can continue to use the same ARN. But if you generate a new certificate for your custom domain name, replace the original configuration with the new ARN in this request.
ACM certificates for custom domains must be in the US East (N. Virginia) 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 Configuring a user pool domain.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is a convenience which creates an instance of the
UpdateUserPoolDomainRequest.Builderavoiding the need to create one manually viaUpdateUserPoolDomainRequest.builder()- Parameters:
updateUserPoolDomainRequest- AConsumerthat will call methods onUpdateUserPoolDomainRequest.Builderto create a request. The UpdateUserPoolDomain request input.- Returns:
- Result of the UpdateUserPoolDomain operation returned by the service.
- Throws:
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.FeatureUnavailableInTierException- This exception is thrown when a feature you attempted to configure isn't available in your current feature plan.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
verifySoftwareToken
default VerifySoftwareTokenResponse verifySoftwareToken(VerifySoftwareTokenRequest verifySoftwareTokenRequest) throws InvalidParameterException, ResourceNotFoundException, InvalidUserPoolConfigurationException, NotAuthorizedException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, EnableSoftwareTokenMfaException, SoftwareTokenMfaNotFoundException, CodeMismatchException, ForbiddenException, 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.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
- Parameters:
verifySoftwareTokenRequest-- Returns:
- Result of the VerifySoftwareToken operation returned by the service.
- Throws:
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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
verifySoftwareToken
default VerifySoftwareTokenResponse verifySoftwareToken(Consumer<VerifySoftwareTokenRequest.Builder> verifySoftwareTokenRequest) throws InvalidParameterException, ResourceNotFoundException, InvalidUserPoolConfigurationException, NotAuthorizedException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, EnableSoftwareTokenMfaException, SoftwareTokenMfaNotFoundException, CodeMismatchException, ForbiddenException, 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.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
This is a convenience which creates an instance of the
VerifySoftwareTokenRequest.Builderavoiding the need to create one manually viaVerifySoftwareTokenRequest.builder()- Parameters:
verifySoftwareTokenRequest- AConsumerthat will call methods onVerifySoftwareTokenRequest.Builderto create a request.- Returns:
- Result of the VerifySoftwareToken operation returned by the service.
- Throws:
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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
verifyUserAttribute
default VerifyUserAttributeResponse verifyUserAttribute(VerifyUserAttributeRequest verifyUserAttributeRequest) throws ResourceNotFoundException, InvalidParameterException, CodeMismatchException, ExpiredCodeException, NotAuthorizedException, TooManyRequestsException, LimitExceededException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AliasExistsException, ForbiddenException, 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.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
- Parameters:
verifyUserAttributeRequest- Represents the request to verify user attributes.- Returns:
- Result of the VerifyUserAttribute operation returned by the service.
- Throws:
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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
verifyUserAttribute
default VerifyUserAttributeResponse verifyUserAttribute(Consumer<VerifyUserAttributeRequest.Builder> verifyUserAttributeRequest) throws ResourceNotFoundException, InvalidParameterException, CodeMismatchException, ExpiredCodeException, NotAuthorizedException, TooManyRequestsException, LimitExceededException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, AliasExistsException, ForbiddenException, 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.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin.Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
This is a convenience which creates an instance of the
VerifyUserAttributeRequest.Builderavoiding the need to create one manually viaVerifyUserAttributeRequest.builder()- Parameters:
verifyUserAttributeRequest- AConsumerthat will call methods onVerifyUserAttributeRequest.Builderto create a request. Represents the request to verify user attributes.- Returns:
- Result of the VerifyUserAttribute operation returned by the service.
- Throws:
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.ForbiddenException- This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CognitoIdentityProviderException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
create
static CognitoIdentityProviderClient create()
Create aCognitoIdentityProviderClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static CognitoIdentityProviderClientBuilder builder()
Create a builder that can be used to configure and create aCognitoIdentityProviderClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default CognitoIdentityProviderServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-