public interface AmazonCognitoIdentityProvider
Using the Amazon Cognito User Pools API, you can create a user pool to manage directories and users. You can authenticate a user to obtain tokens related to user identity and access policies.
This API reference provides information about user pools in Amazon Cognito User Pools.
For more information, see the Amazon Cognito Documentation.
| Modifier and Type | Method and Description |
|---|---|
AddCustomAttributesResult |
addCustomAttributes(AddCustomAttributesRequest addCustomAttributesRequest)
Adds additional user attributes to the user pool schema.
|
void |
adminAddUserToGroup(AdminAddUserToGroupRequest adminAddUserToGroupRequest)
Adds the specified user to the specified group.
|
AdminConfirmSignUpResult |
adminConfirmSignUp(AdminConfirmSignUpRequest adminConfirmSignUpRequest)
Confirms user registration as an admin without using a confirmation code.
|
AdminCreateUserResult |
adminCreateUser(AdminCreateUserRequest adminCreateUserRequest)
Creates a new user in the specified user pool.
|
void |
adminDeleteUser(AdminDeleteUserRequest adminDeleteUserRequest)
Deletes a user as an administrator.
|
AdminDeleteUserAttributesResult |
adminDeleteUserAttributes(AdminDeleteUserAttributesRequest adminDeleteUserAttributesRequest)
Deletes the user attributes in a user pool as an administrator.
|
AdminDisableProviderForUserResult |
adminDisableProviderForUser(AdminDisableProviderForUserRequest adminDisableProviderForUserRequest)
Disables the user from signing in with the specified external (SAML or
social) identity provider.
|
AdminDisableUserResult |
adminDisableUser(AdminDisableUserRequest adminDisableUserRequest)
Disables the specified user.
|
AdminEnableUserResult |
adminEnableUser(AdminEnableUserRequest adminEnableUserRequest)
Enables the specified user as an administrator.
|
void |
adminForgetDevice(AdminForgetDeviceRequest adminForgetDeviceRequest)
Forgets the device, as an administrator.
|
AdminGetDeviceResult |
adminGetDevice(AdminGetDeviceRequest adminGetDeviceRequest)
Gets the device, as an administrator.
|
AdminGetUserResult |
adminGetUser(AdminGetUserRequest adminGetUserRequest)
Gets the specified user by user name in a user pool as an administrator.
|
AdminInitiateAuthResult |
adminInitiateAuth(AdminInitiateAuthRequest adminInitiateAuthRequest)
Initiates the authentication flow, as an administrator.
|
AdminLinkProviderForUserResult |
adminLinkProviderForUser(AdminLinkProviderForUserRequest adminLinkProviderForUserRequest)
Links an existing user account in a user pool (
DestinationUser) to an identity from an external identity
provider (SourceUser) based on a specified attribute name
and value from the external identity provider. |
AdminListDevicesResult |
adminListDevices(AdminListDevicesRequest adminListDevicesRequest)
Lists devices, as an administrator.
|
AdminListGroupsForUserResult |
adminListGroupsForUser(AdminListGroupsForUserRequest adminListGroupsForUserRequest)
Lists the groups that the user belongs to.
|
AdminListUserAuthEventsResult |
adminListUserAuthEvents(AdminListUserAuthEventsRequest adminListUserAuthEventsRequest)
Lists a history of user activity and any risks detected as part of Amazon
Cognito advanced security.
|
void |
adminRemoveUserFromGroup(AdminRemoveUserFromGroupRequest adminRemoveUserFromGroupRequest)
Removes the specified user from the specified group.
|
AdminResetUserPasswordResult |
adminResetUserPassword(AdminResetUserPasswordRequest adminResetUserPasswordRequest)
Resets the specified user's password in a user pool as an administrator.
|
AdminRespondToAuthChallengeResult |
adminRespondToAuthChallenge(AdminRespondToAuthChallengeRequest adminRespondToAuthChallengeRequest)
Responds to an authentication challenge, as an administrator.
|
AdminSetUserMFAPreferenceResult |
adminSetUserMFAPreference(AdminSetUserMFAPreferenceRequest adminSetUserMFAPreferenceRequest)
Sets the user's multi-factor authentication (MFA) preference, including
which MFA options are enabled and if any are preferred.
|
AdminSetUserPasswordResult |
adminSetUserPassword(AdminSetUserPasswordRequest adminSetUserPasswordRequest)
Sets the specified user's password in a user pool as an administrator.
|
AdminSetUserSettingsResult |
adminSetUserSettings(AdminSetUserSettingsRequest adminSetUserSettingsRequest)
This action is no longer supported. You can use it to configure
only SMS MFA.
|
AdminUpdateAuthEventFeedbackResult |
adminUpdateAuthEventFeedback(AdminUpdateAuthEventFeedbackRequest adminUpdateAuthEventFeedbackRequest)
Provides feedback for an authentication event as to whether it was from a
valid user.
|
AdminUpdateDeviceStatusResult |
adminUpdateDeviceStatus(AdminUpdateDeviceStatusRequest adminUpdateDeviceStatusRequest)
Updates the device status as an administrator.
|
AdminUpdateUserAttributesResult |
adminUpdateUserAttributes(AdminUpdateUserAttributesRequest adminUpdateUserAttributesRequest)
Updates the specified user's attributes, including developer attributes,
as an administrator.
|
AdminUserGlobalSignOutResult |
adminUserGlobalSignOut(AdminUserGlobalSignOutRequest adminUserGlobalSignOutRequest)
Signs out users from all devices, as an administrator.
|
AssociateSoftwareTokenResult |
associateSoftwareToken(AssociateSoftwareTokenRequest associateSoftwareTokenRequest)
Returns a unique generated shared secret key code for the user account.
|
ChangePasswordResult |
changePassword(ChangePasswordRequest changePasswordRequest)
Changes the password for a specified user in a user pool.
|
ConfirmDeviceResult |
confirmDevice(ConfirmDeviceRequest confirmDeviceRequest)
Confirms tracking of the device.
|
ConfirmForgotPasswordResult |
confirmForgotPassword(ConfirmForgotPasswordRequest confirmForgotPasswordRequest)
Allows a user to enter a confirmation code to reset a forgotten password.
|
ConfirmSignUpResult |
confirmSignUp(ConfirmSignUpRequest confirmSignUpRequest)
Confirms registration of a user and handles the existing alias from a
previous user.
|
CreateGroupResult |
createGroup(CreateGroupRequest createGroupRequest)
Creates a new group in the specified user pool.
|
CreateIdentityProviderResult |
createIdentityProvider(CreateIdentityProviderRequest createIdentityProviderRequest)
Creates an identity provider for a user pool.
|
CreateResourceServerResult |
createResourceServer(CreateResourceServerRequest createResourceServerRequest)
Creates a new OAuth2.0 resource server and defines custom scopes in it.
|
CreateUserImportJobResult |
createUserImportJob(CreateUserImportJobRequest createUserImportJobRequest)
Creates the user import job.
|
CreateUserPoolResult |
createUserPool(CreateUserPoolRequest createUserPoolRequest)
Creates a new Amazon Cognito user pool and sets the password policy for
the pool.
|
CreateUserPoolClientResult |
createUserPoolClient(CreateUserPoolClientRequest createUserPoolClientRequest)
Creates the user pool client.
|
CreateUserPoolDomainResult |
createUserPoolDomain(CreateUserPoolDomainRequest createUserPoolDomainRequest)
Creates a new domain for a user pool.
|
void |
deleteGroup(DeleteGroupRequest deleteGroupRequest)
Deletes a group.
|
void |
deleteIdentityProvider(DeleteIdentityProviderRequest deleteIdentityProviderRequest)
Deletes an identity provider for a user pool.
|
void |
deleteResourceServer(DeleteResourceServerRequest deleteResourceServerRequest)
Deletes a resource server.
|
void |
deleteUser(DeleteUserRequest deleteUserRequest)
Allows a user to delete himself or herself.
|
DeleteUserAttributesResult |
deleteUserAttributes(DeleteUserAttributesRequest deleteUserAttributesRequest)
Deletes the attributes for a user.
|
void |
deleteUserPool(DeleteUserPoolRequest deleteUserPoolRequest)
Deletes the specified Amazon Cognito user pool.
|
void |
deleteUserPoolClient(DeleteUserPoolClientRequest deleteUserPoolClientRequest)
Allows the developer to delete the user pool client.
|
DeleteUserPoolDomainResult |
deleteUserPoolDomain(DeleteUserPoolDomainRequest deleteUserPoolDomainRequest)
Deletes a domain for a user pool.
|
DescribeIdentityProviderResult |
describeIdentityProvider(DescribeIdentityProviderRequest describeIdentityProviderRequest)
Gets information about a specific identity provider.
|
DescribeResourceServerResult |
describeResourceServer(DescribeResourceServerRequest describeResourceServerRequest)
Describes a resource server.
|
DescribeRiskConfigurationResult |
describeRiskConfiguration(DescribeRiskConfigurationRequest describeRiskConfigurationRequest)
Describes the risk configuration.
|
DescribeUserImportJobResult |
describeUserImportJob(DescribeUserImportJobRequest describeUserImportJobRequest)
Describes the user import job.
|
DescribeUserPoolResult |
describeUserPool(DescribeUserPoolRequest describeUserPoolRequest)
Returns the configuration information and metadata of the specified user
pool.
|
DescribeUserPoolClientResult |
describeUserPoolClient(DescribeUserPoolClientRequest describeUserPoolClientRequest)
Client method for returning the configuration information and metadata of
the specified user pool app client.
|
DescribeUserPoolDomainResult |
describeUserPoolDomain(DescribeUserPoolDomainRequest describeUserPoolDomainRequest)
Gets information about a domain.
|
void |
forgetDevice(ForgetDeviceRequest forgetDeviceRequest)
Forgets the specified device.
|
ForgotPasswordResult |
forgotPassword(ForgotPasswordRequest forgotPasswordRequest)
Calling this API causes a message to be sent to the end user with a
confirmation code that is required to change the user's password.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request,
typically used for debugging issues where a service isn't acting as
expected.
|
GetCSVHeaderResult |
getCSVHeader(GetCSVHeaderRequest getCSVHeaderRequest)
Gets the header information for the .csv file to be used as input for the
user import job.
|
GetDeviceResult |
getDevice(GetDeviceRequest getDeviceRequest)
Gets the device.
|
GetGroupResult |
getGroup(GetGroupRequest getGroupRequest)
Gets a group.
|
GetIdentityProviderByIdentifierResult |
getIdentityProviderByIdentifier(GetIdentityProviderByIdentifierRequest getIdentityProviderByIdentifierRequest)
Gets the specified identity provider.
|
GetSigningCertificateResult |
getSigningCertificate(GetSigningCertificateRequest getSigningCertificateRequest)
This method takes a user pool ID, and returns the signing certificate.
|
GetUICustomizationResult |
getUICustomization(GetUICustomizationRequest getUICustomizationRequest)
Gets the UI Customization information for a particular app client's app
UI, if there is something set.
|
GetUserResult |
getUser(GetUserRequest getUserRequest)
Gets the user attributes and metadata for a user.
|
GetUserAttributeVerificationCodeResult |
getUserAttributeVerificationCode(GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest)
Gets the user attribute verification code for the specified attribute
name.
|
GetUserPoolMfaConfigResult |
getUserPoolMfaConfig(GetUserPoolMfaConfigRequest getUserPoolMfaConfigRequest)
Gets the user pool multi-factor authentication (MFA) configuration.
|
GlobalSignOutResult |
globalSignOut(GlobalSignOutRequest globalSignOutRequest)
Signs out users from all devices.
|
InitiateAuthResult |
initiateAuth(InitiateAuthRequest initiateAuthRequest)
Initiates the authentication flow.
|
ListDevicesResult |
listDevices(ListDevicesRequest listDevicesRequest)
Lists the devices.
|
ListGroupsResult |
listGroups(ListGroupsRequest listGroupsRequest)
Lists the groups associated with a user pool.
|
ListIdentityProvidersResult |
listIdentityProviders(ListIdentityProvidersRequest listIdentityProvidersRequest)
Lists information about all identity providers for a user pool.
|
ListResourceServersResult |
listResourceServers(ListResourceServersRequest listResourceServersRequest)
Lists the resource servers for a user pool.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags that are assigned to an Amazon Cognito user pool.
|
ListUserImportJobsResult |
listUserImportJobs(ListUserImportJobsRequest listUserImportJobsRequest)
Lists the user import jobs.
|
ListUserPoolClientsResult |
listUserPoolClients(ListUserPoolClientsRequest listUserPoolClientsRequest)
Lists the clients that have been created for the specified user pool.
|
ListUserPoolsResult |
listUserPools(ListUserPoolsRequest listUserPoolsRequest)
Lists the user pools associated with an AWS account.
|
ListUsersResult |
listUsers(ListUsersRequest listUsersRequest)
Lists the users in the Amazon Cognito user pool.
|
ListUsersInGroupResult |
listUsersInGroup(ListUsersInGroupRequest listUsersInGroupRequest)
Lists the users in the specified group.
|
ResendConfirmationCodeResult |
resendConfirmationCode(ResendConfirmationCodeRequest resendConfirmationCodeRequest)
Resends the confirmation (for confirmation of registration) to a specific
user in the user pool.
|
RespondToAuthChallengeResult |
respondToAuthChallenge(RespondToAuthChallengeRequest respondToAuthChallengeRequest)
Responds to the authentication challenge.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client
("https://cognito-idp.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
setEndpoint(String), sets the
regional endpoint for this client's service calls. |
SetRiskConfigurationResult |
setRiskConfiguration(SetRiskConfigurationRequest setRiskConfigurationRequest)
Configures actions on detected risks.
|
SetUICustomizationResult |
setUICustomization(SetUICustomizationRequest setUICustomizationRequest)
Sets the UI customization information for a user pool's built-in app UI.
|
SetUserMFAPreferenceResult |
setUserMFAPreference(SetUserMFAPreferenceRequest setUserMFAPreferenceRequest)
Set the user's multi-factor authentication (MFA) method preference,
including which MFA factors are enabled and if any are preferred.
|
SetUserPoolMfaConfigResult |
setUserPoolMfaConfig(SetUserPoolMfaConfigRequest setUserPoolMfaConfigRequest)
Set the user pool multi-factor authentication (MFA) configuration.
|
SetUserSettingsResult |
setUserSettings(SetUserSettingsRequest setUserSettingsRequest)
This action is no longer supported. You can use it to configure
only SMS MFA.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
SignUpResult |
signUp(SignUpRequest signUpRequest)
Registers the user in the specified user pool and creates a user name,
password, and user attributes.
|
StartUserImportJobResult |
startUserImportJob(StartUserImportJobRequest startUserImportJobRequest)
Starts the user import.
|
StopUserImportJobResult |
stopUserImportJob(StopUserImportJobRequest stopUserImportJobRequest)
Stops the user import job.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Assigns a set of tags to an Amazon Cognito user pool.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes the specified tags from an Amazon Cognito user pool.
|
UpdateAuthEventFeedbackResult |
updateAuthEventFeedback(UpdateAuthEventFeedbackRequest updateAuthEventFeedbackRequest)
Provides the feedback for an authentication event whether it was from a
valid user or not.
|
UpdateDeviceStatusResult |
updateDeviceStatus(UpdateDeviceStatusRequest updateDeviceStatusRequest)
Updates the device status.
|
UpdateGroupResult |
updateGroup(UpdateGroupRequest updateGroupRequest)
Updates the specified group with the specified attributes.
|
UpdateIdentityProviderResult |
updateIdentityProvider(UpdateIdentityProviderRequest updateIdentityProviderRequest)
Updates identity provider information for a user pool.
|
UpdateResourceServerResult |
updateResourceServer(UpdateResourceServerRequest updateResourceServerRequest)
Updates the name and scopes of resource server.
|
UpdateUserAttributesResult |
updateUserAttributes(UpdateUserAttributesRequest updateUserAttributesRequest)
Allows a user to update a specific attribute (one at a time).
|
UpdateUserPoolResult |
updateUserPool(UpdateUserPoolRequest updateUserPoolRequest)
Updates the specified user pool with the specified attributes.
|
UpdateUserPoolClientResult |
updateUserPoolClient(UpdateUserPoolClientRequest updateUserPoolClientRequest)
Updates the specified user pool app client with the specified attributes.
|
UpdateUserPoolDomainResult |
updateUserPoolDomain(UpdateUserPoolDomainRequest updateUserPoolDomainRequest)
Updates the Secure Sockets Layer (SSL) certificate for the custom domain
for your user pool.
|
VerifySoftwareTokenResult |
verifySoftwareToken(VerifySoftwareTokenRequest verifySoftwareTokenRequest)
Use this API to register a user's entered TOTP code and mark the user's
software token MFA status as "verified" if successful.
|
VerifyUserAttributeResult |
verifyUserAttribute(VerifyUserAttributeRequest verifyUserAttributeRequest)
Verifies the specified user attributes in the user pool.
|
void setEndpoint(String endpoint) throws IllegalArgumentException
Callers can pass in just the endpoint (ex:
"cognito-idp.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "https://cognito-idp.us-east-1.amazonaws.com"). If the
protocol is not specified here, the default protocol from this client's
ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint - The endpoint (ex: "cognito-idp.us-east-1.amazonaws.com")
or a full URL, including the protocol (ex:
"https://cognito-idp.us-east-1.amazonaws.com") of the region
specific AWS endpoint this client will communicate with.IllegalArgumentException - If any problems are detected with the
specified endpoint.void setRegion(Region region) throws IllegalArgumentException
setEndpoint(String), sets the
regional endpoint for this client's service calls. Callers can use this
method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol.
To use http instead, specify it in the ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region - The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions) for
accessing a given region.IllegalArgumentException - If the given region is null,
or if this service isn't available in the given region. See
Region.isServiceSupported(String)Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class,
com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)AddCustomAttributesResult addCustomAttributes(AddCustomAttributesRequest addCustomAttributesRequest) throws AmazonClientException, AmazonServiceException
Adds additional user attributes to the user pool schema.
addCustomAttributesRequest - Represents the request to add custom attributes.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserImportInProgressExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.void adminAddUserToGroup(AdminAddUserToGroupRequest adminAddUserToGroupRequest) throws AmazonClientException, AmazonServiceException
Adds the specified user to the specified group.
Calling this action requires developer credentials.
adminAddUserToGroupRequest - InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.AdminConfirmSignUpResult adminConfirmSignUp(AdminConfirmSignUpRequest adminConfirmSignUpRequest) throws AmazonClientException, AmazonServiceException
Confirms user registration as an admin without using a confirmation code. Works on any user.
Calling this action requires developer credentials.
adminConfirmSignUpRequest - Represents the request to confirm user registration.
ResourceNotFoundExceptionInvalidParameterExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionNotAuthorizedExceptionTooManyFailedAttemptsExceptionInvalidLambdaResponseExceptionTooManyRequestsExceptionLimitExceededExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.AdminCreateUserResult adminCreateUser(AdminCreateUserRequest adminCreateUserRequest) throws AmazonClientException, AmazonServiceException
Creates a new user in the specified user pool.
If MessageAction is not set, the default is to send a
welcome message via email or phone (SMS).
This message is based on a template that you configured in your call to or . This template includes your custom sign-up instructions and placeholders for user name and temporary password.
Alternatively, you can call AdminCreateUser with “SUPPRESS” for the
MessageAction parameter, and Amazon Cognito will not send
any email.
In either case, the user will be in the
FORCE_CHANGE_PASSWORD state until they sign in and change
their password.
AdminCreateUser requires developer credentials.
adminCreateUserRequest - Represents the request to create a user in the specified user pool.
ResourceNotFoundExceptionInvalidParameterExceptionUserNotFoundExceptionUsernameExistsExceptionInvalidPasswordExceptionCodeDeliveryFailureExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionInvalidLambdaResponseExceptionPreconditionNotMetExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionTooManyRequestsExceptionNotAuthorizedExceptionUnsupportedUserStateExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.void adminDeleteUser(AdminDeleteUserRequest adminDeleteUserRequest) throws AmazonClientException, AmazonServiceException
Deletes a user as an administrator. Works on any user.
Calling this action requires developer credentials.
adminDeleteUserRequest - Represents the request to delete a user as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.AdminDeleteUserAttributesResult adminDeleteUserAttributes(AdminDeleteUserAttributesRequest adminDeleteUserAttributesRequest) throws AmazonClientException, AmazonServiceException
Deletes the user attributes in a user pool as an administrator. Works on any user.
Calling this action requires developer credentials.
adminDeleteUserAttributesRequest - Represents the request to delete user attributes as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.AdminDisableProviderForUserResult adminDisableProviderForUser(AdminDisableProviderForUserRequest adminDisableProviderForUserRequest) throws AmazonClientException, AmazonServiceException
Disables the user from signing in with the specified external (SAML or
social) identity provider. If the user to disable is a Cognito User Pools
native username + password user, they are not permitted to use their
password to sign-in. If the user to disable is a linked external IdP
user, any link between that user and an existing user is removed. The
next time the external user (no longer attached to the previously linked
DestinationUser) signs in, they must create a new user
account. See .
This action is enabled only for admin access and requires developer credentials.
The ProviderName must match the value specified when
creating an IdP for the pool.
To disable a native username + password user, the
ProviderName value must be Cognito and the
ProviderAttributeName must be Cognito_Subject,
with the ProviderAttributeValue being the name that is used
in the user pool for the user.
The ProviderAttributeName must always be
Cognito_Subject for social identity providers. The
ProviderAttributeValue must always be the exact subject that
was used when the user was originally linked as a source user.
For de-linking a SAML identity, there are two scenarios. If the linked
identity has not yet been used to sign-in, the
ProviderAttributeName and
ProviderAttributeValue must be the same values that were
used for the SourceUser when the identities were originally
linked in the call. (If the linking was done with
ProviderAttributeName set to Cognito_Subject,
the same applies here). However, if the user has already signed in, the
ProviderAttributeName must be Cognito_Subject
and ProviderAttributeValue must be the subject of the SAML
assertion.
adminDisableProviderForUserRequest - ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionAliasExistsExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.AdminDisableUserResult adminDisableUser(AdminDisableUserRequest adminDisableUserRequest) throws AmazonClientException, AmazonServiceException
Disables the specified user.
Calling this action requires developer credentials.
adminDisableUserRequest - Represents the request to disable any user as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.AdminEnableUserResult adminEnableUser(AdminEnableUserRequest adminEnableUserRequest) throws AmazonClientException, AmazonServiceException
Enables the specified user as an administrator. Works on any user.
Calling this action requires developer credentials.
adminEnableUserRequest - Represents the request that enables the user as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.void adminForgetDevice(AdminForgetDeviceRequest adminForgetDeviceRequest) throws AmazonClientException, AmazonServiceException
Forgets the device, as an administrator.
Calling this action requires developer credentials.
adminForgetDeviceRequest - Sends the forgot device request, as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionInvalidUserPoolConfigurationExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.AdminGetDeviceResult adminGetDevice(AdminGetDeviceRequest adminGetDeviceRequest) throws AmazonClientException, AmazonServiceException
Gets the device, as an administrator.
Calling this action requires developer credentials.
adminGetDeviceRequest - Represents the request to get the device, as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionInvalidUserPoolConfigurationExceptionTooManyRequestsExceptionInternalErrorExceptionNotAuthorizedExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.AdminGetUserResult adminGetUser(AdminGetUserRequest adminGetUserRequest) throws AmazonClientException, AmazonServiceException
Gets the specified user by user name in a user pool as an administrator. Works on any user.
Calling this action requires developer credentials.
adminGetUserRequest - Represents the request to get the specified user as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.AdminInitiateAuthResult adminInitiateAuth(AdminInitiateAuthRequest adminInitiateAuthRequest) throws AmazonClientException, AmazonServiceException
Initiates the authentication flow, as an administrator.
Calling this action requires developer credentials.
adminInitiateAuthRequest - Initiates the authorization request, as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptionUnexpectedLambdaExceptionInvalidUserPoolConfigurationExceptionUserLambdaValidationExceptionInvalidLambdaResponseExceptionMFAMethodNotFoundExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.AdminLinkProviderForUserResult adminLinkProviderForUser(AdminLinkProviderForUserRequest adminLinkProviderForUserRequest) throws AmazonClientException, AmazonServiceException
Links an existing user account in a user pool (
DestinationUser) to an identity from an external identity
provider (SourceUser) based on a specified attribute name
and value from the external identity provider. This allows you to create
a link from the existing user account to an external federated user
identity that has not yet been used to sign in, so that the federated
user identity can be used to sign in as the existing user account.
For example, if there is an existing user with a username and password, this API links that user to a federated user identity, so that when the federated user identity is used, the user signs in as the existing user account.
Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external identity providers and provider attributes that have been trusted by the application owner.
See also .
This action is enabled only for admin access and requires developer credentials.
adminLinkProviderForUserRequest - ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionAliasExistsExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.AdminListDevicesResult adminListDevices(AdminListDevicesRequest adminListDevicesRequest) throws AmazonClientException, AmazonServiceException
Lists devices, as an administrator.
Calling this action requires developer credentials.
adminListDevicesRequest - Represents the request to list devices, as an administrator.
InvalidParameterExceptionResourceNotFoundExceptionInvalidUserPoolConfigurationExceptionTooManyRequestsExceptionInternalErrorExceptionNotAuthorizedExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.AdminListGroupsForUserResult adminListGroupsForUser(AdminListGroupsForUserRequest adminListGroupsForUserRequest) throws AmazonClientException, AmazonServiceException
Lists the groups that the user belongs to.
Calling this action requires developer credentials.
adminListGroupsForUserRequest - InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.AdminListUserAuthEventsResult adminListUserAuthEvents(AdminListUserAuthEventsRequest adminListUserAuthEventsRequest) throws AmazonClientException, AmazonServiceException
Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security.
adminListUserAuthEventsRequest - InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionUserPoolAddOnNotEnabledExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.void adminRemoveUserFromGroup(AdminRemoveUserFromGroupRequest adminRemoveUserFromGroupRequest) throws AmazonClientException, AmazonServiceException
Removes the specified user from the specified group.
Calling this action requires developer credentials.
adminRemoveUserFromGroupRequest - InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.AdminResetUserPasswordResult adminResetUserPassword(AdminResetUserPasswordRequest adminResetUserPasswordRequest) throws AmazonClientException, AmazonServiceException
Resets the specified user's password in a user pool as an administrator. Works on any user.
When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password.
Calling this action requires developer credentials.
adminResetUserPasswordRequest - Represents the request to reset a user's password as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionNotAuthorizedExceptionInvalidLambdaResponseExceptionTooManyRequestsExceptionLimitExceededExceptionUserNotFoundExceptionInvalidSmsRoleAccessPolicyExceptionInvalidEmailRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.AdminRespondToAuthChallengeResult adminRespondToAuthChallenge(AdminRespondToAuthChallengeRequest adminRespondToAuthChallengeRequest) throws AmazonClientException, AmazonServiceException
Responds to an authentication challenge, as an administrator.
Calling this action requires developer credentials.
adminRespondToAuthChallengeRequest - The request to respond to the authentication challenge, as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionCodeMismatchExceptionExpiredCodeExceptionUnexpectedLambdaExceptionInvalidPasswordExceptionUserLambdaValidationExceptionInvalidLambdaResponseExceptionTooManyRequestsExceptionInvalidUserPoolConfigurationExceptionInternalErrorExceptionMFAMethodNotFoundExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionAliasExistsExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionSoftwareTokenMFANotFoundExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.AdminSetUserMFAPreferenceResult adminSetUserMFAPreference(AdminSetUserMFAPreferenceRequest adminSetUserMFAPreferenceRequest) throws AmazonClientException, AmazonServiceException
Sets the user's multi-factor authentication (MFA) preference, including which MFA options are enabled and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are enabled. If multiple options are enabled and no preference is set, a challenge to choose an MFA option will be returned during sign in.
adminSetUserMFAPreferenceRequest - ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.AdminSetUserPasswordResult adminSetUserPassword(AdminSetUserPasswordRequest adminSetUserPasswordRequest) throws AmazonClientException, AmazonServiceException
Sets the specified user's password in a user pool as an administrator. Works on any user.
The password can be temporary or permanent. If it is temporary, the user
status will be placed into the FORCE_CHANGE_PASSWORD state.
When the user next tries to sign in, the InitiateAuth/AdminInitiateAuth
response will contain the NEW_PASSWORD_REQUIRED challenge.
If the user does not sign in before it expires, the user will not be able
to sign in and their password will need to be reset by an administrator.
Once the user has set a new password, or the password is permanent, the
user status will be set to Confirmed.
adminSetUserPasswordRequest - ResourceNotFoundExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptionTooManyRequestsExceptionInvalidParameterExceptionInvalidPasswordExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.AdminSetUserSettingsResult adminSetUserSettings(AdminSetUserSettingsRequest adminSetUserSettingsRequest) throws AmazonClientException, AmazonServiceException
This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either type of MFA, use the AdminSetUserMFAPreference action instead.
adminSetUserSettingsRequest - You can use this parameter to set an MFA configuration that uses the SMS delivery medium.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.AdminUpdateAuthEventFeedbackResult adminUpdateAuthEventFeedback(AdminUpdateAuthEventFeedbackRequest adminUpdateAuthEventFeedbackRequest) throws AmazonClientException, AmazonServiceException
Provides feedback for an authentication event as to whether it was from a valid user. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.
adminUpdateAuthEventFeedbackRequest - InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionUserPoolAddOnNotEnabledExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.AdminUpdateDeviceStatusResult adminUpdateDeviceStatus(AdminUpdateDeviceStatusRequest adminUpdateDeviceStatusRequest) throws AmazonClientException, AmazonServiceException
Updates the device status as an administrator.
Calling this action requires developer credentials.
adminUpdateDeviceStatusRequest - The request to update the device status, as an administrator.
InvalidParameterExceptionResourceNotFoundExceptionInvalidUserPoolConfigurationExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.AdminUpdateUserAttributesResult adminUpdateUserAttributes(AdminUpdateUserAttributesRequest adminUpdateUserAttributesRequest) throws AmazonClientException, AmazonServiceException
Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.
For custom attributes, you must prepend the custom: prefix
to the attribute name.
In addition to updating user attributes, this API can also be used to mark phone and email as verified.
Calling this action requires developer credentials.
adminUpdateUserAttributesRequest - Represents the request to update the user's attributes as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionInvalidLambdaResponseExceptionAliasExistsExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptionInvalidSmsRoleAccessPolicyExceptionInvalidEmailRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.AdminUserGlobalSignOutResult adminUserGlobalSignOut(AdminUserGlobalSignOutRequest adminUserGlobalSignOutRequest) throws AmazonClientException, AmazonServiceException
Signs out users from all devices, as an administrator. It also invalidates all refresh tokens issued to a user. The user's current access and Id tokens remain valid until their expiry. Access and Id tokens expire one hour after they are issued.
Calling this action requires developer credentials.
adminUserGlobalSignOutRequest - The request to sign out of all devices, as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.AssociateSoftwareTokenResult associateSoftwareToken(AssociateSoftwareTokenRequest associateSoftwareTokenRequest) throws AmazonClientException, AmazonServiceException
Returns a unique generated shared secret key code for the user account. The request takes an access token or a session string, but not both.
associateSoftwareTokenRequest - InvalidParameterExceptionNotAuthorizedExceptionResourceNotFoundExceptionInternalErrorExceptionSoftwareTokenMFANotFoundExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.ChangePasswordResult changePassword(ChangePasswordRequest changePasswordRequest) throws AmazonClientException, AmazonServiceException
Changes the password for a specified user in a user pool.
changePasswordRequest - Represents the request to change a user password.
ResourceNotFoundExceptionInvalidParameterExceptionInvalidPasswordExceptionNotAuthorizedExceptionTooManyRequestsExceptionLimitExceededExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.ConfirmDeviceResult confirmDevice(ConfirmDeviceRequest confirmDeviceRequest) throws AmazonClientException, AmazonServiceException
Confirms tracking of the device. This API call is the call that begins device tracking.
confirmDeviceRequest - Confirms the device request.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionInvalidPasswordExceptionInvalidLambdaResponseExceptionUsernameExistsExceptionInvalidUserPoolConfigurationExceptionTooManyRequestsExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.ConfirmForgotPasswordResult confirmForgotPassword(ConfirmForgotPasswordRequest confirmForgotPasswordRequest) throws AmazonClientException, AmazonServiceException
Allows a user to enter a confirmation code to reset a forgotten password.
confirmForgotPasswordRequest - The request representing the confirmation for a password reset.
ResourceNotFoundExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionInvalidParameterExceptionInvalidPasswordExceptionNotAuthorizedExceptionCodeMismatchExceptionExpiredCodeExceptionTooManyFailedAttemptsExceptionInvalidLambdaResponseExceptionTooManyRequestsExceptionLimitExceededExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.ConfirmSignUpResult confirmSignUp(ConfirmSignUpRequest confirmSignUpRequest) throws AmazonClientException, AmazonServiceException
Confirms registration of a user and handles the existing alias from a previous user.
confirmSignUpRequest - Represents the request to confirm registration of a user.
ResourceNotFoundExceptionInvalidParameterExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionNotAuthorizedExceptionTooManyFailedAttemptsExceptionCodeMismatchExceptionExpiredCodeExceptionInvalidLambdaResponseExceptionAliasExistsExceptionTooManyRequestsExceptionLimitExceededExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.CreateGroupResult createGroup(CreateGroupRequest createGroupRequest) throws AmazonClientException, AmazonServiceException
Creates a new group in the specified user pool.
Calling this action requires developer credentials.
createGroupRequest - InvalidParameterExceptionGroupExistsExceptionResourceNotFoundExceptionTooManyRequestsExceptionLimitExceededExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.CreateIdentityProviderResult createIdentityProvider(CreateIdentityProviderRequest createIdentityProviderRequest) throws AmazonClientException, AmazonServiceException
Creates an identity provider for a user pool.
createIdentityProviderRequest - InvalidParameterExceptionDuplicateProviderExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionLimitExceededExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.CreateResourceServerResult createResourceServer(CreateResourceServerRequest createResourceServerRequest) throws AmazonClientException, AmazonServiceException
Creates a new OAuth2.0 resource server and defines custom scopes in it.
createResourceServerRequest - InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionLimitExceededExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.CreateUserImportJobResult createUserImportJob(CreateUserImportJobRequest createUserImportJobRequest) throws AmazonClientException, AmazonServiceException
Creates the user import job.
createUserImportJobRequest - Represents the request to create the user import job.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionPreconditionNotMetExceptionNotAuthorizedExceptionLimitExceededExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.CreateUserPoolResult createUserPool(CreateUserPoolRequest createUserPoolRequest) throws AmazonClientException, AmazonServiceException
Creates a new Amazon Cognito user pool and sets the password policy for the pool.
createUserPoolRequest - Represents the request to create a user pool.
InvalidParameterExceptionTooManyRequestsExceptionLimitExceededExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionInvalidEmailRoleAccessPolicyExceptionNotAuthorizedExceptionUserPoolTaggingExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.CreateUserPoolClientResult createUserPoolClient(CreateUserPoolClientRequest createUserPoolClientRequest) throws AmazonClientException, AmazonServiceException
Creates the user pool client.
createUserPoolClientRequest - Represents the request to create a user pool client.
InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionLimitExceededExceptionNotAuthorizedExceptionScopeDoesNotExistExceptionInvalidOAuthFlowExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.CreateUserPoolDomainResult createUserPoolDomain(CreateUserPoolDomainRequest createUserPoolDomainRequest) throws AmazonClientException, AmazonServiceException
Creates a new domain for a user pool.
createUserPoolDomainRequest - InvalidParameterExceptionNotAuthorizedExceptionResourceNotFoundExceptionLimitExceededExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.void deleteGroup(DeleteGroupRequest deleteGroupRequest) throws AmazonClientException, AmazonServiceException
Deletes a group. Currently only groups with no members can be deleted.
Calling this action requires developer credentials.
deleteGroupRequest - ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.void deleteIdentityProvider(DeleteIdentityProviderRequest deleteIdentityProviderRequest) throws AmazonClientException, AmazonServiceException
Deletes an identity provider for a user pool.
deleteIdentityProviderRequest - InvalidParameterExceptionUnsupportedIdentityProviderExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.void deleteResourceServer(DeleteResourceServerRequest deleteResourceServerRequest) throws AmazonClientException, AmazonServiceException
Deletes a resource server.
deleteResourceServerRequest - InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.void deleteUser(DeleteUserRequest deleteUserRequest) throws AmazonClientException, AmazonServiceException
Allows a user to delete himself or herself.
deleteUserRequest - Represents the request to delete a user.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionTooManyRequestsExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.DeleteUserAttributesResult deleteUserAttributes(DeleteUserAttributesRequest deleteUserAttributesRequest) throws AmazonClientException, AmazonServiceException
Deletes the attributes for a user.
deleteUserAttributesRequest - Represents the request to delete user attributes.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionTooManyRequestsExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.void deleteUserPool(DeleteUserPoolRequest deleteUserPoolRequest) throws AmazonClientException, AmazonServiceException
Deletes the specified Amazon Cognito user pool.
deleteUserPoolRequest - Represents the request to delete a user pool.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserImportInProgressExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.void deleteUserPoolClient(DeleteUserPoolClientRequest deleteUserPoolClientRequest) throws AmazonClientException, AmazonServiceException
Allows the developer to delete the user pool client.
deleteUserPoolClientRequest - Represents the request to delete a user pool client.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.DeleteUserPoolDomainResult deleteUserPoolDomain(DeleteUserPoolDomainRequest deleteUserPoolDomainRequest) throws AmazonClientException, AmazonServiceException
Deletes a domain for a user pool.
deleteUserPoolDomainRequest - NotAuthorizedExceptionInvalidParameterExceptionResourceNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.DescribeIdentityProviderResult describeIdentityProvider(DescribeIdentityProviderRequest describeIdentityProviderRequest) throws AmazonClientException, AmazonServiceException
Gets information about a specific identity provider.
describeIdentityProviderRequest - InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.DescribeResourceServerResult describeResourceServer(DescribeResourceServerRequest describeResourceServerRequest) throws AmazonClientException, AmazonServiceException
Describes a resource server.
describeResourceServerRequest - InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.DescribeRiskConfigurationResult describeRiskConfiguration(DescribeRiskConfigurationRequest describeRiskConfigurationRequest) throws AmazonClientException, AmazonServiceException
Describes the risk configuration.
describeRiskConfigurationRequest - ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserPoolAddOnNotEnabledExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.DescribeUserImportJobResult describeUserImportJob(DescribeUserImportJobRequest describeUserImportJobRequest) throws AmazonClientException, AmazonServiceException
Describes the user import job.
describeUserImportJobRequest - Represents the request to describe the user import job.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.DescribeUserPoolResult describeUserPool(DescribeUserPoolRequest describeUserPoolRequest) throws AmazonClientException, AmazonServiceException
Returns the configuration information and metadata of the specified user pool.
describeUserPoolRequest - Represents the request to describe the user pool.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserPoolTaggingExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.DescribeUserPoolClientResult describeUserPoolClient(DescribeUserPoolClientRequest describeUserPoolClientRequest) throws AmazonClientException, AmazonServiceException
Client method for returning the configuration information and metadata of the specified user pool app client.
describeUserPoolClientRequest - Represents the request to describe a user pool client.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.DescribeUserPoolDomainResult describeUserPoolDomain(DescribeUserPoolDomainRequest describeUserPoolDomainRequest) throws AmazonClientException, AmazonServiceException
Gets information about a domain.
describeUserPoolDomainRequest - NotAuthorizedExceptionInvalidParameterExceptionResourceNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.void forgetDevice(ForgetDeviceRequest forgetDeviceRequest) throws AmazonClientException, AmazonServiceException
Forgets the specified device.
forgetDeviceRequest - Represents the request to forget the device.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionTooManyRequestsExceptionInvalidUserPoolConfigurationExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.ForgotPasswordResult forgotPassword(ForgotPasswordRequest forgotPasswordRequest) throws AmazonClientException, AmazonServiceException
Calling this API causes a message to be sent to the end user with a
confirmation code that is required to change the user's password. For the
Username parameter, you can use the username or user alias.
The method used to send the confirmation code is sent according to the
specified AccountRecoverySetting. For more information, see Recovering User Accounts in the Amazon Cognito Developer
Guide. If neither a verified phone number nor a verified email
exists, an InvalidParameterException is thrown. To use the
confirmation code for resetting the password, call .
forgotPasswordRequest - Represents the request to reset a user's password.
ResourceNotFoundExceptionInvalidParameterExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionNotAuthorizedExceptionInvalidLambdaResponseExceptionTooManyRequestsExceptionLimitExceededExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionInvalidEmailRoleAccessPolicyExceptionCodeDeliveryFailureExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.GetCSVHeaderResult getCSVHeader(GetCSVHeaderRequest getCSVHeaderRequest) throws AmazonClientException, AmazonServiceException
Gets the header information for the .csv file to be used as input for the user import job.
getCSVHeaderRequest - Represents the request to get the header information for the .csv file for the user import job.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.GetDeviceResult getDevice(GetDeviceRequest getDeviceRequest) throws AmazonClientException, AmazonServiceException
Gets the device.
getDeviceRequest - Represents the request to get the device.
ResourceNotFoundExceptionInvalidParameterExceptionInvalidUserPoolConfigurationExceptionNotAuthorizedExceptionTooManyRequestsExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.GetGroupResult getGroup(GetGroupRequest getGroupRequest) throws AmazonClientException, AmazonServiceException
Gets a group.
Calling this action requires developer credentials.
getGroupRequest - ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.GetIdentityProviderByIdentifierResult getIdentityProviderByIdentifier(GetIdentityProviderByIdentifierRequest getIdentityProviderByIdentifierRequest) throws AmazonClientException, AmazonServiceException
Gets the specified identity provider.
getIdentityProviderByIdentifierRequest - InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.GetSigningCertificateResult getSigningCertificate(GetSigningCertificateRequest getSigningCertificateRequest) throws AmazonClientException, AmazonServiceException
This method takes a user pool ID, and returns the signing certificate.
getSigningCertificateRequest - Request to get a signing certificate from Cognito.
InternalErrorExceptionInvalidParameterExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.GetUICustomizationResult getUICustomization(GetUICustomizationRequest getUICustomizationRequest) throws AmazonClientException, AmazonServiceException
Gets the UI Customization information for a particular app client's app
UI, if there is something set. If nothing is set for the particular
client, but there is an existing pool level customization (app
clientId will be ALL), then that is returned.
If nothing is present, then an empty shape is returned.
getUICustomizationRequest - InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.GetUserResult getUser(GetUserRequest getUserRequest) throws AmazonClientException, AmazonServiceException
Gets the user attributes and metadata for a user.
getUserRequest - Represents the request to get information about the user.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionTooManyRequestsExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.GetUserAttributeVerificationCodeResult getUserAttributeVerificationCode(GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest) throws AmazonClientException, AmazonServiceException
Gets the user attribute verification code for the specified attribute name.
getUserAttributeVerificationCodeRequest - Represents the request to get user attribute verification.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionInvalidLambdaResponseExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionInvalidEmailRoleAccessPolicyExceptionCodeDeliveryFailureExceptionLimitExceededExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.GetUserPoolMfaConfigResult getUserPoolMfaConfig(GetUserPoolMfaConfigRequest getUserPoolMfaConfigRequest) throws AmazonClientException, AmazonServiceException
Gets the user pool multi-factor authentication (MFA) configuration.
getUserPoolMfaConfigRequest - InvalidParameterExceptionTooManyRequestsExceptionResourceNotFoundExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.GlobalSignOutResult globalSignOut(GlobalSignOutRequest globalSignOutRequest) throws AmazonClientException, AmazonServiceException
Signs out users from all devices. It also invalidates all refresh tokens issued to a user. The user's current access and Id tokens remain valid until their expiry. Access and Id tokens expire one hour after they are issued.
globalSignOutRequest - Represents the request to sign out all devices.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionTooManyRequestsExceptionPasswordResetRequiredExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.InitiateAuthResult initiateAuth(InitiateAuthRequest initiateAuthRequest) throws AmazonClientException, AmazonServiceException
Initiates the authentication flow.
initiateAuthRequest - Initiates the authentication request.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionTooManyRequestsExceptionUnexpectedLambdaExceptionInvalidUserPoolConfigurationExceptionUserLambdaValidationExceptionInvalidLambdaResponseExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.ListDevicesResult listDevices(ListDevicesRequest listDevicesRequest) throws AmazonClientException, AmazonServiceException
Lists the devices.
listDevicesRequest - Represents the request to list the devices.
InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionInvalidUserPoolConfigurationExceptionTooManyRequestsExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.ListGroupsResult listGroups(ListGroupsRequest listGroupsRequest) throws AmazonClientException, AmazonServiceException
Lists the groups associated with a user pool.
Calling this action requires developer credentials.
listGroupsRequest - InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.ListIdentityProvidersResult listIdentityProviders(ListIdentityProvidersRequest listIdentityProvidersRequest) throws AmazonClientException, AmazonServiceException
Lists information about all identity providers for a user pool.
listIdentityProvidersRequest - InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.ListResourceServersResult listResourceServers(ListResourceServersRequest listResourceServersRequest) throws AmazonClientException, AmazonServiceException
Lists the resource servers for a user pool.
listResourceServersRequest - InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws AmazonClientException, AmazonServiceException
Lists the tags that are assigned to an Amazon Cognito user pool.
A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
You can use this action up to 10 times per second, per account.
listTagsForResourceRequest - ResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInvalidParameterExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.ListUserImportJobsResult listUserImportJobs(ListUserImportJobsRequest listUserImportJobsRequest) throws AmazonClientException, AmazonServiceException
Lists the user import jobs.
listUserImportJobsRequest - Represents the request to list the user import jobs.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.ListUserPoolClientsResult listUserPoolClients(ListUserPoolClientsRequest listUserPoolClientsRequest) throws AmazonClientException, AmazonServiceException
Lists the clients that have been created for the specified user pool.
listUserPoolClientsRequest - Represents the request to list the user pool clients.
InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.ListUserPoolsResult listUserPools(ListUserPoolsRequest listUserPoolsRequest) throws AmazonClientException, AmazonServiceException
Lists the user pools associated with an AWS account.
listUserPoolsRequest - Represents the request to list user pools.
InvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.ListUsersResult listUsers(ListUsersRequest listUsersRequest) throws AmazonClientException, AmazonServiceException
Lists the users in the Amazon Cognito user pool.
listUsersRequest - Represents the request to list users.
InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.ListUsersInGroupResult listUsersInGroup(ListUsersInGroupRequest listUsersInGroupRequest) throws AmazonClientException, AmazonServiceException
Lists the users in the specified group.
Calling this action requires developer credentials.
listUsersInGroupRequest - InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.ResendConfirmationCodeResult resendConfirmationCode(ResendConfirmationCodeRequest resendConfirmationCodeRequest) throws AmazonClientException, AmazonServiceException
Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
resendConfirmationCodeRequest - Represents the request to resend the confirmation code.
ResourceNotFoundExceptionInvalidParameterExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionNotAuthorizedExceptionInvalidLambdaResponseExceptionTooManyRequestsExceptionLimitExceededExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionInvalidEmailRoleAccessPolicyExceptionCodeDeliveryFailureExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.RespondToAuthChallengeResult respondToAuthChallenge(RespondToAuthChallengeRequest respondToAuthChallengeRequest) throws AmazonClientException, AmazonServiceException
Responds to the authentication challenge.
respondToAuthChallengeRequest - The request to respond to an authentication challenge.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionCodeMismatchExceptionExpiredCodeExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionInvalidPasswordExceptionInvalidLambdaResponseExceptionTooManyRequestsExceptionInvalidUserPoolConfigurationExceptionMFAMethodNotFoundExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionAliasExistsExceptionInternalErrorExceptionSoftwareTokenMFANotFoundExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.SetRiskConfigurationResult setRiskConfiguration(SetRiskConfigurationRequest setRiskConfigurationRequest) throws AmazonClientException, AmazonServiceException
Configures actions on detected risks. To delete the risk configuration
for UserPoolId or ClientId, pass null values
for all four configuration types.
To enable Amazon Cognito advanced security features, update the user pool
to include the UserPoolAddOns key
AdvancedSecurityMode.
See .
setRiskConfigurationRequest - ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserPoolAddOnNotEnabledExceptionCodeDeliveryFailureExceptionInvalidEmailRoleAccessPolicyExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.SetUICustomizationResult setUICustomization(SetUICustomizationRequest setUICustomizationRequest) throws AmazonClientException, AmazonServiceException
Sets the UI customization information for a user pool's built-in app UI.
You can specify app UI customization settings for a single client (with a
specific clientId) or for all clients (by setting the
clientId to ALL). If you specify
ALL, the default configuration will be used for every client
that has no UI customization set previously. If you specify UI
customization settings for a particular client, it will no longer fall
back to the ALL configuration.
To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app's pages, and the service will throw an error.
setUICustomizationRequest - InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.SetUserMFAPreferenceResult setUserMFAPreference(SetUserMFAPreferenceRequest setUserMFAPreferenceRequest) throws AmazonClientException, AmazonServiceException
Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are enabled and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are enabled. If multiple options are enabled and no preference is set, a challenge to choose an MFA option will be returned during sign in.
setUserMFAPreferenceRequest - ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.SetUserPoolMfaConfigResult setUserPoolMfaConfig(SetUserPoolMfaConfigRequest setUserPoolMfaConfigRequest) throws AmazonClientException, AmazonServiceException
Set the user pool multi-factor authentication (MFA) configuration.
setUserPoolMfaConfigRequest - InvalidParameterExceptionTooManyRequestsExceptionResourceNotFoundExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.SetUserSettingsResult setUserSettings(SetUserSettingsRequest setUserSettingsRequest) throws AmazonClientException, AmazonServiceException
This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either type of MFA, use the SetUserMFAPreference action instead.
setUserSettingsRequest - Represents the request to set user settings.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.SignUpResult signUp(SignUpRequest signUpRequest) throws AmazonClientException, AmazonServiceException
Registers the user in the specified user pool and creates a user name, password, and user attributes.
signUpRequest - Represents the request to register a user.
ResourceNotFoundExceptionInvalidParameterExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionNotAuthorizedExceptionInvalidPasswordExceptionInvalidLambdaResponseExceptionUsernameExistsExceptionTooManyRequestsExceptionInternalErrorExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionInvalidEmailRoleAccessPolicyExceptionCodeDeliveryFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.StartUserImportJobResult startUserImportJob(StartUserImportJobRequest startUserImportJobRequest) throws AmazonClientException, AmazonServiceException
Starts the user import.
startUserImportJobRequest - Represents the request to start the user import job.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionInternalErrorExceptionPreconditionNotMetExceptionNotAuthorizedExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.StopUserImportJobResult stopUserImportJob(StopUserImportJobRequest stopUserImportJobRequest) throws AmazonClientException, AmazonServiceException
Stops the user import job.
stopUserImportJobRequest - Represents the request to stop the user import job.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionInternalErrorExceptionPreconditionNotMetExceptionNotAuthorizedExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.TagResourceResult tagResource(TagResourceRequest tagResourceRequest) throws AmazonClientException, AmazonServiceException
Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
Each tag consists of a key and value, both of which you define. A key is
a general category for more specific values. For example, if you have two
versions of a user pool, one for testing and another for production, you
might assign an Environment tag key to both user pools. The
value of this key might be Test for one user pool and
Production for the other.
Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your user pools. In an IAM policy, you can constrain permissions for user pools based on specific tags or tag values.
You can use this action up to 5 times per second, per account. A user pool can have as many as 50 tags.
tagResourceRequest - ResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInvalidParameterExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest) throws AmazonClientException, AmazonServiceException
Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account
untagResourceRequest - ResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInvalidParameterExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.UpdateAuthEventFeedbackResult updateAuthEventFeedback(UpdateAuthEventFeedbackRequest updateAuthEventFeedbackRequest) throws AmazonClientException, AmazonServiceException
Provides the feedback for an authentication event whether it was from a valid user or not. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.
updateAuthEventFeedbackRequest - InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionUserPoolAddOnNotEnabledExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.UpdateDeviceStatusResult updateDeviceStatus(UpdateDeviceStatusRequest updateDeviceStatusRequest) throws AmazonClientException, AmazonServiceException
Updates the device status.
updateDeviceStatusRequest - Represents the request to update the device status.
InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionInvalidUserPoolConfigurationExceptionTooManyRequestsExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.UpdateGroupResult updateGroup(UpdateGroupRequest updateGroupRequest) throws AmazonClientException, AmazonServiceException
Updates the specified group with the specified attributes.
Calling this action requires developer credentials.
If you don't provide a value for an attribute, it will be set to the default value.
updateGroupRequest - ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.UpdateIdentityProviderResult updateIdentityProvider(UpdateIdentityProviderRequest updateIdentityProviderRequest) throws AmazonClientException, AmazonServiceException
Updates identity provider information for a user pool.
updateIdentityProviderRequest - InvalidParameterExceptionUnsupportedIdentityProviderExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.UpdateResourceServerResult updateResourceServer(UpdateResourceServerRequest updateResourceServerRequest) throws AmazonClientException, AmazonServiceException
Updates the name and scopes of resource server. All other fields are read-only.
If you don't provide a value for an attribute, it will be set to the default value.
updateResourceServerRequest - InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.UpdateUserAttributesResult updateUserAttributes(UpdateUserAttributesRequest updateUserAttributesRequest) throws AmazonClientException, AmazonServiceException
Allows a user to update a specific attribute (one at a time).
updateUserAttributesRequest - Represents the request to update user attributes.
ResourceNotFoundExceptionInvalidParameterExceptionCodeMismatchExceptionExpiredCodeExceptionNotAuthorizedExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionInvalidLambdaResponseExceptionTooManyRequestsExceptionAliasExistsExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionInvalidEmailRoleAccessPolicyExceptionCodeDeliveryFailureExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.UpdateUserPoolResult updateUserPool(UpdateUserPoolRequest updateUserPoolRequest) throws AmazonClientException, AmazonServiceException
Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings with .
If you don't provide a value for an attribute, it will be set to the default value.
updateUserPoolRequest - Represents the request to update the user pool.
ResourceNotFoundExceptionInvalidParameterExceptionConcurrentModificationExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserImportInProgressExceptionInternalErrorExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionUserPoolTaggingExceptionInvalidEmailRoleAccessPolicyExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.UpdateUserPoolClientResult updateUserPoolClient(UpdateUserPoolClientRequest updateUserPoolClientRequest) throws AmazonClientException, AmazonServiceException
Updates the specified user pool app client with the specified attributes. You can get a list of the current user pool app client settings with .
If you don't provide a value for an attribute, it will be set to the default value.
updateUserPoolClientRequest - Represents the request to update the user pool client.
ResourceNotFoundExceptionInvalidParameterExceptionConcurrentModificationExceptionTooManyRequestsExceptionNotAuthorizedExceptionScopeDoesNotExistExceptionInvalidOAuthFlowExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.UpdateUserPoolDomainResult updateUserPoolDomain(UpdateUserPoolDomainRequest updateUserPoolDomainRequest) throws AmazonClientException, AmazonServiceException
Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.
You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You cannot use it to change the domain for a user pool.
A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and sign-in pages for your application. When you set up a custom domain, you provide a certificate that you manage with AWS Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain.
Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same, and your custom domain uses the new certificate automatically.
However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide this ARN to Amazon Cognito.
When you add your new certificate in ACM, you must choose US East (N. Virginia) as the AWS Region.
After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain.
For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
updateUserPoolDomainRequest - The UpdateUserPoolDomain request input.
InvalidParameterExceptionNotAuthorizedExceptionResourceNotFoundExceptionTooManyRequestsExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.VerifySoftwareTokenResult verifySoftwareToken(VerifySoftwareTokenRequest verifySoftwareTokenRequest) throws AmazonClientException, AmazonServiceException
Use this API to register a user's entered TOTP code and mark the user's software token MFA status as "verified" if successful. The request takes an access token or a session string, but not both.
verifySoftwareTokenRequest - InvalidParameterExceptionResourceNotFoundExceptionInvalidUserPoolConfigurationExceptionNotAuthorizedExceptionTooManyRequestsExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionEnableSoftwareTokenMFAExceptionNotAuthorizedExceptionSoftwareTokenMFANotFoundExceptionCodeMismatchExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.VerifyUserAttributeResult verifyUserAttribute(VerifyUserAttributeRequest verifyUserAttributeRequest) throws AmazonClientException, AmazonServiceException
Verifies the specified user attributes in the user pool.
verifyUserAttributeRequest - Represents the request to verify user attributes.
ResourceNotFoundExceptionInvalidParameterExceptionCodeMismatchExceptionExpiredCodeExceptionNotAuthorizedExceptionTooManyRequestsExceptionLimitExceededExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.Copyright © 2020. All rights reserved.