public interface AmazonCognitoIdentityProvider
With the Amazon Cognito user pools API, you can set up user pools and app clients, and authenticate users. To authenticate users from third-party identity providers (IdPs) in this API, you can link IdP users to native user profiles. Learn more about the authentication and authorization of federated users in the Using the Amazon Cognito user pools API and user pool endpoints.
This API reference provides detailed information about API operations and object types in Amazon Cognito. At the bottom of the page for each API operation and object, under See Also, you can learn how to use it in an Amazon Web Services SDK in the language of your choice.
Along with resource management operations, the Amazon Cognito user pools API includes classes of operations and authorization models for client-side and server-side user operations. For more information, see Using the Amazon Cognito native and OIDC APIs in the Amazon Cognito Developer Guide.
You can also start reading about the CognitoIdentityProvider
client in the following SDK guides.
To get started with an Amazon Web Services SDK, see Tools to Build on Amazon Web Services. For example actions and scenarios, see Code examples for Amazon Cognito Identity Provider using Amazon Web Services SDKs.
| 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)
Prevents the user from signing in with the specified external (SAML or
social) identity provider (IdP).
|
AdminDisableUserResult |
adminDisableUser(AdminDisableUserRequest adminDisableUserRequest)
Deactivates a user and revokes all access tokens for the 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 IdP (
SourceUser) based on a specified attribute name and value
from the external IdP. |
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)
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)
The user's multi-factor authentication (MFA) preference, including which
MFA options are activated, 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 indicating if it was from a
valid user.
|
AdminUpdateDeviceStatusResult |
adminUpdateDeviceStatus(AdminUpdateDeviceStatusRequest adminUpdateDeviceStatusRequest)
Updates the device status as an administrator.
|
AdminUpdateUserAttributesResult |
adminUpdateUserAttributes(AdminUpdateUserAttributesRequest adminUpdateUserAttributesRequest)
|
AdminUserGlobalSignOutResult |
adminUserGlobalSignOut(AdminUserGlobalSignOutRequest adminUserGlobalSignOutRequest)
Signs out a user from all devices.
|
AssociateSoftwareTokenResult |
associateSoftwareToken(AssociateSoftwareTokenRequest associateSoftwareTokenRequest)
Begins setup of time-based one-time password (TOTP) multi-factor
authentication (MFA) for a user, with a unique private key that Amazon
Cognito generates and returns in the API response.
|
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 new user.
|
CreateGroupResult |
createGroup(CreateGroupRequest createGroupRequest)
Creates a new group in the specified user pool.
|
CreateIdentityProviderResult |
createIdentityProvider(CreateIdentityProviderRequest createIdentityProviderRequest)
Creates an IdP for a user pool.
|
CreateResourceServerResult |
createResourceServer(CreateResourceServerRequest createResourceServerRequest)
Creates a new OAuth2.0 resource server and defines custom scopes within
it.
|
CreateUserImportJobResult |
createUserImportJob(CreateUserImportJobRequest createUserImportJobRequest)
Creates a user import job.
|
CreateUserPoolResult |
createUserPool(CreateUserPoolRequest createUserPoolRequest)
|
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 IdP for a user pool.
|
void |
deleteResourceServer(DeleteResourceServerRequest deleteResourceServerRequest)
Deletes a resource server.
|
void |
deleteUser(DeleteUserRequest deleteUserRequest)
Allows a user to delete their own user profile.
|
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 IdP.
|
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.
|
com.amazonaws.ResponseMetadata |
getCachedResponseMetadata(com.amazonaws.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 comma-separated value (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 IdP.
|
GetLogDeliveryConfigurationResult |
getLogDeliveryConfiguration(GetLogDeliveryConfigurationRequest getLogDeliveryConfigurationRequest)
Gets the detailed activity logging configuration for a user pool.
|
GetSigningCertificateResult |
getSigningCertificate(GetSigningCertificateRequest getSigningCertificateRequest)
This method takes a user pool ID, and returns the signing certificate.
|
GetUICustomizationResult |
getUICustomization(GetUICustomizationRequest getUICustomizationRequest)
Gets the user interface (UI) Customization information for a particular
app client's app UI, if any such information exists for the client.
|
GetUserResult |
getUser(GetUserRequest getUserRequest)
Gets the user attributes and metadata for a user.
|
GetUserAttributeVerificationCodeResult |
getUserAttributeVerificationCode(GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest)
Generates a 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 a user from all devices.
|
InitiateAuthResult |
initiateAuth(InitiateAuthRequest initiateAuthRequest)
Initiates sign-in for a user in the Amazon Cognito user directory.
|
ListDevicesResult |
listDevices(ListDevicesRequest listDevicesRequest)
Lists the sign-in devices that Amazon Cognito has registered to the
current user.
|
ListGroupsResult |
listGroups(ListGroupsRequest listGroupsRequest)
Lists the groups associated with a user pool.
|
ListIdentityProvidersResult |
listIdentityProviders(ListIdentityProvidersRequest listIdentityProvidersRequest)
Lists information about all IdPs 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 user import jobs for a user pool.
|
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 Amazon Web Services account.
|
ListUsersResult |
listUsers(ListUsersRequest listUsersRequest)
Lists users and their basic details in a 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.
|
RevokeTokenResult |
revokeToken(RevokeTokenRequest revokeTokenRequest)
Revokes all of the access tokens generated by, and at the same time as,
the specified refresh token.
|
void |
setEndpoint(java.lang.String endpoint)
Overrides the default endpoint for this client
("https://cognito-idp.us-east-1.amazonaws.com").
|
SetLogDeliveryConfigurationResult |
setLogDeliveryConfiguration(SetLogDeliveryConfigurationRequest setLogDeliveryConfigurationRequest)
Sets up or modifies the detailed activity logging configuration of a user
pool.
|
void |
setRegion(com.amazonaws.regions.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 user interface (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 activated and if any are preferred.
|
SetUserPoolMfaConfigResult |
setUserPoolMfaConfig(SetUserPoolMfaConfigRequest setUserPoolMfaConfigRequest)
Sets 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 IdP 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)
|
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 time-based one-time password
(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(java.lang.String endpoint)
throws java.lang.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.java.lang.IllegalArgumentException - If any problems are detected with the
specified endpoint.void setRegion(com.amazonaws.regions.Region region)
throws java.lang.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.java.lang.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Adds additional user attributes to the user pool schema.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
addCustomAttributesRequest - Represents the request to add custom attributes.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserImportInProgressExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Adds the specified user to the specified group.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
adminAddUserToGroupRequest - InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Confirms user registration as an admin without using a confirmation code. Works on any user.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
adminConfirmSignUpRequest - Confirm a user's registration as a user pool administrator.
ResourceNotFoundExceptionInvalidParameterExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionNotAuthorizedExceptionTooManyFailedAttemptsExceptionInvalidLambdaResponseExceptionTooManyRequestsExceptionLimitExceededExceptionUserNotFoundExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Creates a new user in the specified user pool.
If MessageAction isn't set, the default is to send a welcome
message via email or phone (SMS).
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
This message is based on a template that you configured in your call to create or update a user pool. This template includes your custom sign-up instructions and placeholders for user name and temporary password.
Alternatively, you can call AdminCreateUser with
SUPPRESS for the MessageAction parameter, and
Amazon Cognito won't send any email.
In either case, the user will be in the
FORCE_CHANGE_PASSWORD state until they sign in and change
their password.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
adminCreateUserRequest - Represents the request to create a user in the specified user pool.
ResourceNotFoundExceptionInvalidParameterExceptionUserNotFoundExceptionUsernameExistsExceptionInvalidPasswordExceptionCodeDeliveryFailureExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionInvalidLambdaResponseExceptionPreconditionNotMetExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionTooManyRequestsExceptionNotAuthorizedExceptionUnsupportedUserStateExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Deletes a user as an administrator. Works on any user.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
adminDeleteUserRequest - Represents the request to delete a user as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Deletes the user attributes in a user pool as an administrator. Works on any user.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
adminDeleteUserAttributesRequest - Represents the request to delete user attributes as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Prevents the user from signing in with the specified external (SAML or
social) identity provider (IdP). If the user that you want to deactivate
is a Amazon Cognito user pools native username + password user, they
can't use their password to sign in. If the user to deactivate is a
linked external IdP user, any link between that user and an existing user
is removed. When the external user signs in again, and the user is no
longer attached to the previously linked DestinationUser,
the user must create a new user account. See AdminLinkProviderForUser.
The ProviderName must match the value specified when
creating an IdP for the pool.
To deactivate a native username + password user, the
ProviderName value must be Cognito and the
ProviderAttributeName must be Cognito_Subject.
The ProviderAttributeValue must be the name that is used in
the user pool for the user.
The ProviderAttributeName must always be
Cognito_Subject for social IdPs. The
ProviderAttributeValue must always be the exact subject that
was used when the user was originally linked as a source user.
For de-linking a SAML identity, there are two scenarios. If the linked
identity has not yet been used to sign in, the
ProviderAttributeName and
ProviderAttributeValue must be the same values that were
used for the SourceUser when the identities were originally
linked using AdminLinkProviderForUser call. (If the linking
was done with ProviderAttributeName set to
Cognito_Subject, the same applies here). However, if the
user has already signed in, the ProviderAttributeName must
be Cognito_Subject and ProviderAttributeValue
must be the subject of the SAML assertion.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
adminDisableProviderForUserRequest - ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionAliasExistsExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Deactivates a user and revokes all access tokens for the user. A
deactivated user can't sign in, but still appears in the responses to
GetUser and ListUsers API requests.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
adminDisableUserRequest - Represents the request to disable the user as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Enables the specified user as an administrator. Works on any user.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
adminEnableUserRequest - Represents the request that enables the user as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Forgets the device, as an administrator.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
adminForgetDeviceRequest - Sends the forgot device request, as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionInvalidUserPoolConfigurationExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Gets the device, as an administrator.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
adminGetDeviceRequest - Represents the request to get the device, as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionInvalidUserPoolConfigurationExceptionTooManyRequestsExceptionInternalErrorExceptionNotAuthorizedExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Gets the specified user by user name in a user pool as an administrator. Works on any user.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
adminGetUserRequest - Represents the request to get the specified user as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Initiates the authentication flow, as an administrator.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
adminInitiateAuthRequest - Initiates the authorization request, as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptionUnexpectedLambdaExceptionInvalidUserPoolConfigurationExceptionUserLambdaValidationExceptionInvalidLambdaResponseExceptionMFAMethodNotFoundExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Links an existing user account in a user pool (
DestinationUser) to an identity from an external IdP (
SourceUser) based on a specified attribute name and value
from the external IdP. This allows you to create a link from the existing
user account to an external federated user identity that has not yet been
used to sign in. You can then use the federated user identity to sign in
as the existing user account.
For example, if there is an existing user with a username and password, this API links that user to a federated user identity. When the user signs in with a federated user identity, they sign in as the existing user account.
The maximum number of federated identities linked to a user is five.
Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external IdPs and provider attributes that have been trusted by the application owner.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
adminLinkProviderForUserRequest - ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionAliasExistsExceptionLimitExceededExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Lists devices, as an administrator.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
adminListDevicesRequest - Represents the request to list devices, as an administrator.
InvalidParameterExceptionResourceNotFoundExceptionInvalidUserPoolConfigurationExceptionTooManyRequestsExceptionInternalErrorExceptionNotAuthorizedExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Lists the groups that the user belongs to.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
adminListGroupsForUserRequest - InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
A history of user activity and any risks detected as part of Amazon Cognito advanced security.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
adminListUserAuthEventsRequest - InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionUserPoolAddOnNotEnabledExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Removes the specified user from the specified group.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
adminRemoveUserFromGroupRequest - InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Resets the specified user's password in a user pool as an administrator. Works on any user.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Deactivates a user's password, requiring them to change it. If a user
tries to sign in after the API is called, Amazon Cognito responds with a
PasswordResetRequiredException error. Your app must then
perform the actions that reset your user's password: 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.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
adminResetUserPasswordRequest - Represents the request to reset a user's password as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionNotAuthorizedExceptionInvalidLambdaResponseExceptionTooManyRequestsExceptionLimitExceededExceptionUserNotFoundExceptionInvalidSmsRoleAccessPolicyExceptionInvalidEmailRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Responds to an authentication challenge, as an administrator.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
adminRespondToAuthChallengeRequest - The request to respond to the authentication challenge, as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionCodeMismatchExceptionExpiredCodeExceptionUnexpectedLambdaExceptionInvalidPasswordExceptionUserLambdaValidationExceptionInvalidLambdaResponseExceptionTooManyRequestsExceptionInvalidUserPoolConfigurationExceptionInternalErrorExceptionMFAMethodNotFoundExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionAliasExistsExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionSoftwareTokenMFANotFoundExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
The user's multi-factor authentication (MFA) preference, including which MFA options are activated, and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are activated. If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
adminSetUserMFAPreferenceRequest - ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.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 enters the FORCE_CHANGE_PASSWORD state. When the user
next tries to sign in, the InitiateAuth/AdminInitiateAuth response will
contain the NEW_PASSWORD_REQUIRED challenge. If the user
doesn't sign in before it expires, the user won't be able to sign in, and
an administrator must reset their password.
Once the user has set a new password, or the password is permanent, the
user status is set to Confirmed.
AdminSetUserPassword can set a password for the user profile
that Amazon Cognito creates for third-party federated users. When you set
a password, the federated user's status changes from
EXTERNAL_PROVIDER to CONFIRMED. A user in this
state can sign in as a federated user, and initiate authentication flows
in the API like a linked native user. They can also modify their password
and attributes in token-authenticated API requests like
ChangePassword and UpdateUserAttributes. As a
best security practice and to keep users in sync with your external IdP,
don't set passwords on federated user profiles. To set up a federated
user for native sign-in with a linked native user, refer to Linking federated users to an existing user profile.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
adminSetUserPasswordRequest - ResourceNotFoundExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptionTooManyRequestsExceptionInvalidParameterExceptionInvalidPasswordExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software token MFA. To configure either type of MFA, use AdminSetUserMFAPreference instead.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
adminSetUserSettingsRequest - You can use this parameter to set an MFA configuration that uses the SMS delivery medium.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Provides feedback for an authentication event indicating if it was from a valid user. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
adminUpdateAuthEventFeedbackRequest - InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionUserPoolAddOnNotEnabledExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Updates the device status as an administrator.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
adminUpdateDeviceStatusRequest - The request to update the device status, as an administrator.
InvalidParameterExceptionResourceNotFoundExceptionInvalidUserPoolConfigurationExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
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.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
adminUpdateUserAttributesRequest - Represents the request to update the user's attributes as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionInvalidLambdaResponseExceptionAliasExistsExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptionInvalidSmsRoleAccessPolicyExceptionInvalidEmailRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Signs out a user from all devices. AdminUserGlobalSignOut
invalidates all identity, access and refresh tokens that Amazon Cognito
has issued to a user. A user can still use a hosted UI cookie to retrieve
new tokens for the duration of the 1-hour cookie validity period.
Your app isn't aware that a user's access token is revoked unless it
attempts to authorize a user pools API request with an access token that
contains the scope aws.cognito.signin.user.admin. Your app
might otherwise accept access tokens until they expire.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
adminUserGlobalSignOutRequest - The request to sign out of all devices, as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Begins setup of time-based one-time password (TOTP) multi-factor
authentication (MFA) for a user, with a unique private key that Amazon
Cognito generates and returns in the API response. You can authorize an
AssociateSoftwareToken request with either the user's access
token, or a session string from a challenge response that you received
from Amazon Cognito.
Amazon Cognito disassociates an existing software token when you verify
the new token in a VerifySoftwareToken API request. If you don't verify the software
token and your user pool doesn't require MFA, the user can then
authenticate with user name and password credentials alone. If your user
pool requires TOTP MFA, Amazon Cognito generates an
MFA_SETUP or SOFTWARE_TOKEN_SETUP challenge
each time your user signs. Complete setup with
AssociateSoftwareToken and VerifySoftwareToken.
After you set up software token MFA for your user, Amazon Cognito
generates a SOFTWARE_TOKEN_MFA challenge when they
authenticate. Respond to this challenge with your user's TOTP.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
associateSoftwareTokenRequest - ConcurrentModificationExceptionInvalidParameterExceptionNotAuthorizedExceptionResourceNotFoundExceptionInternalErrorExceptionSoftwareTokenMFANotFoundExceptionForbiddenExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Changes the password for a specified user in a user pool.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
changePasswordRequest - Represents the request to change a user password.
ResourceNotFoundExceptionInvalidParameterExceptionInvalidPasswordExceptionNotAuthorizedExceptionTooManyRequestsExceptionLimitExceededExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionForbiddenExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Confirms tracking of the device. This API call is the call that begins device tracking.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
confirmDeviceRequest - Confirms the device request.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionInvalidPasswordExceptionInvalidLambdaResponseExceptionUsernameExistsExceptionInvalidUserPoolConfigurationExceptionTooManyRequestsExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionForbiddenExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Allows a user to enter a confirmation code to reset a forgotten password.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
confirmForgotPasswordRequest - The request representing the confirmation for a password reset.
ResourceNotFoundExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionInvalidParameterExceptionInvalidPasswordExceptionNotAuthorizedExceptionCodeMismatchExceptionExpiredCodeExceptionTooManyFailedAttemptsExceptionInvalidLambdaResponseExceptionTooManyRequestsExceptionLimitExceededExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionForbiddenExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Confirms registration of a new user.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
confirmSignUpRequest - Represents the request to confirm registration of a user.
ResourceNotFoundExceptionInvalidParameterExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionNotAuthorizedExceptionTooManyFailedAttemptsExceptionCodeMismatchExceptionExpiredCodeExceptionInvalidLambdaResponseExceptionAliasExistsExceptionTooManyRequestsExceptionLimitExceededExceptionUserNotFoundExceptionInternalErrorExceptionForbiddenExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Creates a new group in the specified user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
createGroupRequest - InvalidParameterExceptionGroupExistsExceptionResourceNotFoundExceptionTooManyRequestsExceptionLimitExceededExceptionNotAuthorizedExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Creates an IdP for a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
createIdentityProviderRequest - InvalidParameterExceptionDuplicateProviderExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionLimitExceededExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Creates a new OAuth2.0 resource server and defines custom scopes within it.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
createResourceServerRequest - InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionLimitExceededExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Creates a user import job.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
createUserImportJobRequest - Represents the request to create the user import job.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionPreconditionNotMetExceptionNotAuthorizedExceptionLimitExceededExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Creates a new Amazon Cognito user pool and sets the password policy for the pool.
If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
createUserPoolRequest - Represents the request to create a user pool.
InvalidParameterExceptionTooManyRequestsExceptionLimitExceededExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionInvalidEmailRoleAccessPolicyExceptionNotAuthorizedExceptionUserPoolTaggingExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Creates the user pool client.
When you create a new user pool client, token revocation is automatically activated. For more information about revoking tokens, see RevokeToken.
If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
createUserPoolClientRequest - Represents the request to create a user pool client.
InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionLimitExceededExceptionNotAuthorizedExceptionScopeDoesNotExistExceptionInvalidOAuthFlowExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Creates a new domain for a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
createUserPoolDomainRequest - InvalidParameterExceptionNotAuthorizedExceptionResourceNotFoundExceptionLimitExceededExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Deletes a group.
Calling this action requires developer credentials.
deleteGroupRequest - ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Deletes an IdP for a user pool.
deleteIdentityProviderRequest - InvalidParameterExceptionUnsupportedIdentityProviderExceptionConcurrentModificationExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Deletes a resource server.
deleteResourceServerRequest - InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Allows a user to delete their own user profile.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
deleteUserRequest - Represents the request to delete a user.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionTooManyRequestsExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionForbiddenExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Deletes the attributes for a user.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
deleteUserAttributesRequest - Represents the request to delete user attributes.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionTooManyRequestsExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionForbiddenExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Deletes the specified Amazon Cognito user pool.
deleteUserPoolRequest - Represents the request to delete a user pool.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserImportInProgressExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Allows the developer to delete the user pool client.
deleteUserPoolClientRequest - Represents the request to delete a user pool client.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionConcurrentModificationExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Deletes a domain for a user pool.
deleteUserPoolDomainRequest - NotAuthorizedExceptionInvalidParameterExceptionResourceNotFoundExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Gets information about a specific IdP.
describeIdentityProviderRequest - InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Describes a resource server.
describeResourceServerRequest - InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Describes the risk configuration.
describeRiskConfigurationRequest - ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserPoolAddOnNotEnabledExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Describes the user import job.
describeUserImportJobRequest - Represents the request to describe the user import job.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Returns the configuration information and metadata of the specified user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
describeUserPoolRequest - Represents the request to describe the user pool.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserPoolTaggingExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Client method for returning the configuration information and metadata of the specified user pool app client.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
describeUserPoolClientRequest - Represents the request to describe a user pool client.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Gets information about a domain.
describeUserPoolDomainRequest - NotAuthorizedExceptionInvalidParameterExceptionResourceNotFoundExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Forgets the specified device.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
forgetDeviceRequest - Represents the request to forget the device.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionTooManyRequestsExceptionInvalidUserPoolConfigurationExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionForbiddenExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.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. To use the confirmation code for resetting the password, call
ConfirmForgotPassword.
If neither a verified phone number nor a verified email exists, this API
returns InvalidParameterException. If your app client has a
client secret and you don't provide a SECRET_HASH parameter,
this API returns NotAuthorizedException.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
forgotPasswordRequest - Represents the request to reset a user's password.
ResourceNotFoundExceptionInvalidParameterExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionNotAuthorizedExceptionInvalidLambdaResponseExceptionTooManyRequestsExceptionLimitExceededExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionInvalidEmailRoleAccessPolicyExceptionCodeDeliveryFailureExceptionUserNotFoundExceptionInternalErrorExceptionForbiddenExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Gets the header information for the comma-separated value (CSV) file to be used as input for the user import job.
getCSVHeaderRequest - Represents the request to get the header information of the CSV file for the user import job.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Gets the device.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
getDeviceRequest - Represents the request to get the device.
ResourceNotFoundExceptionInvalidParameterExceptionInvalidUserPoolConfigurationExceptionNotAuthorizedExceptionTooManyRequestsExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionForbiddenExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Gets a group.
Calling this action requires developer credentials.
getGroupRequest - ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Gets the specified IdP.
getIdentityProviderByIdentifierRequest - InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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.GetLogDeliveryConfigurationResult getLogDeliveryConfiguration(GetLogDeliveryConfigurationRequest getLogDeliveryConfigurationRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Gets the detailed activity logging configuration for a user pool.
getLogDeliveryConfigurationRequest - InvalidParameterExceptionInternalErrorExceptionTooManyRequestsExceptionNotAuthorizedExceptionResourceNotFoundExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This method takes a user pool ID, and returns the signing certificate. The issued certificate is valid for 10 years from the date of issue.
Amazon Cognito issues and assigns a new signing certificate annually.
This process returns a new value in the response to
GetSigningCertificate, but doesn't invalidate the original
certificate.
getSigningCertificateRequest - Request to get a signing certificate from Amazon Cognito.
InternalErrorExceptionInvalidParameterExceptionResourceNotFoundExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Gets the user interface (UI) Customization information for a particular
app client's app UI, if any such information exists for the client. If
nothing is set for the particular client, but there is an existing pool
level customization (the app clientId is ALL),
then that information is returned. If nothing is present, then an empty
shape is returned.
getUICustomizationRequest - InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Gets the user attributes and metadata for a user.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
getUserRequest - Represents the request to get information about the user.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionTooManyRequestsExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionForbiddenExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Generates a user attribute verification code for the specified attribute name. Sends a message to a user with a code that they must return in a VerifyUserAttribute request.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
getUserAttributeVerificationCodeRequest - Represents the request to get user attribute verification.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionInvalidLambdaResponseExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionInvalidEmailRoleAccessPolicyExceptionCodeDeliveryFailureExceptionLimitExceededExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionForbiddenExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Gets the user pool multi-factor authentication (MFA) configuration.
getUserPoolMfaConfigRequest - InvalidParameterExceptionTooManyRequestsExceptionResourceNotFoundExceptionNotAuthorizedExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Signs out a user from all devices. GlobalSignOut invalidates
all identity, access and refresh tokens that Amazon Cognito has issued to
a user. A user can still use a hosted UI cookie to retrieve new tokens
for the duration of the 1-hour cookie validity period.
Your app isn't aware that a user's access token is revoked unless it
attempts to authorize a user pools API request with an access token that
contains the scope aws.cognito.signin.user.admin. Your app
might otherwise accept access tokens until they expire.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
globalSignOutRequest - Represents the request to sign out all devices.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionTooManyRequestsExceptionPasswordResetRequiredExceptionUserNotConfirmedExceptionInternalErrorExceptionForbiddenExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Initiates sign-in for a user in the Amazon Cognito user directory. You
can't sign in a user with a federated IdP with InitiateAuth.
For more information, see Adding user pool sign-in through a third party.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
initiateAuthRequest - Initiates the authentication request.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionTooManyRequestsExceptionUnexpectedLambdaExceptionInvalidUserPoolConfigurationExceptionUserLambdaValidationExceptionInvalidLambdaResponseExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionForbiddenExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Lists the sign-in devices that Amazon Cognito has registered to the current user.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
listDevicesRequest - Represents the request to list the devices.
InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionInvalidUserPoolConfigurationExceptionTooManyRequestsExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionForbiddenExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Lists the groups associated with a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
listGroupsRequest - InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Lists information about all IdPs for a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
listIdentityProvidersRequest - InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Lists the resource servers for a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
listResourceServersRequest - InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.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 - ResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInvalidParameterExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Lists user import jobs for a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
listUserImportJobsRequest - Represents the request to list the user import jobs.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Lists the clients that have been created for the specified user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
listUserPoolClientsRequest - Represents the request to list the user pool clients.
InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Lists the user pools associated with an Amazon Web Services account.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
listUserPoolsRequest - Represents the request to list user pools.
InvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Lists users and their basic details in a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
listUsersRequest - Represents the request to list users.
InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Lists the users in the specified group.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
listUsersInGroupRequest - InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
resendConfirmationCodeRequest - Represents the request to resend the confirmation code.
ResourceNotFoundExceptionInvalidParameterExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionNotAuthorizedExceptionInvalidLambdaResponseExceptionTooManyRequestsExceptionLimitExceededExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionInvalidEmailRoleAccessPolicyExceptionCodeDeliveryFailureExceptionUserNotFoundExceptionInternalErrorExceptionForbiddenExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Responds to the authentication challenge.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
respondToAuthChallengeRequest - The request to respond to an authentication challenge.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionCodeMismatchExceptionExpiredCodeExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionInvalidPasswordExceptionInvalidLambdaResponseExceptionTooManyRequestsExceptionInvalidUserPoolConfigurationExceptionMFAMethodNotFoundExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionAliasExistsExceptionInternalErrorExceptionSoftwareTokenMFANotFoundExceptionForbiddenExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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.RevokeTokenResult revokeToken(RevokeTokenRequest revokeTokenRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Revokes all of the access tokens generated by, and at the same time as, the specified refresh token. After a token is revoked, you can't use the revoked token to access Amazon Cognito user APIs, or to authorize access to your resource server.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
revokeTokenRequest - TooManyRequestsExceptionInternalErrorExceptionUnauthorizedExceptionInvalidParameterExceptionUnsupportedOperationExceptionUnsupportedTokenTypeExceptionForbiddenExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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.SetLogDeliveryConfigurationResult setLogDeliveryConfiguration(SetLogDeliveryConfigurationRequest setLogDeliveryConfigurationRequest) throws com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Sets up or modifies the detailed activity logging configuration of a user pool.
setLogDeliveryConfigurationRequest - InvalidParameterExceptionInternalErrorExceptionTooManyRequestsExceptionNotAuthorizedExceptionResourceNotFoundExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Configures actions on detected risks. To delete the risk configuration
for UserPoolId or ClientId, pass null values
for all four configuration types.
To activate Amazon Cognito advanced security features, update the user
pool to include the UserPoolAddOns key
AdvancedSecurityMode.
setRiskConfigurationRequest - ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserPoolAddOnNotEnabledExceptionCodeDeliveryFailureExceptionInvalidEmailRoleAccessPolicyExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Sets the user interface (UI) customization information for a user pool's built-in app UI.
You can specify app UI customization settings for a single client (with a
specific clientId) or for all clients (by setting the
clientId to ALL). If you specify
ALL, the default configuration is used for every client that
has no previously set UI customization. If you specify UI customization
settings for a particular client, it will no longer return to the
ALL configuration.
To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app's pages, and the service will throw an error.
setUICustomizationRequest - InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are activated and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are activated. If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts unless device tracking is turned on and the device has been trusted. If you want MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
setUserMFAPreferenceRequest - ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionForbiddenExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Sets the user pool multi-factor authentication (MFA) configuration.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
setUserPoolMfaConfigRequest - InvalidParameterExceptionTooManyRequestsExceptionResourceNotFoundExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionNotAuthorizedExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software token MFA. To configure either type of MFA, use SetUserMFAPreference instead.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
setUserSettingsRequest - Represents the request to set user settings.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionForbiddenExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Registers the user in the specified user pool and creates a user name, password, and user attributes.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
signUpRequest - Represents the request to register a user.
ResourceNotFoundExceptionInvalidParameterExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionNotAuthorizedExceptionInvalidPasswordExceptionInvalidLambdaResponseExceptionUsernameExistsExceptionTooManyRequestsExceptionInternalErrorExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionInvalidEmailRoleAccessPolicyExceptionCodeDeliveryFailureExceptionForbiddenExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Starts the user import.
startUserImportJobRequest - Represents the request to start the user import job.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionInternalErrorExceptionPreconditionNotMetExceptionNotAuthorizedExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Stops the user import job.
stopUserImportJobRequest - Represents the request to stop the user import job.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionInternalErrorExceptionPreconditionNotMetExceptionNotAuthorizedExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.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 Identity and Access Management policy, you can constrain permissions for user pools based on specific tags or tag values.
You can use this action up to 5 times per second, per account. A user pool can have as many as 50 tags.
tagResourceRequest - ResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInvalidParameterExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.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 - ResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInvalidParameterExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.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.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
updateAuthEventFeedbackRequest - InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionUserPoolAddOnNotEnabledExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Updates the device status.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
updateDeviceStatusRequest - Represents the request to update the device status.
InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionInvalidUserPoolConfigurationExceptionTooManyRequestsExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionForbiddenExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Updates the specified group with the specified attributes.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
updateGroupRequest - ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Updates IdP information for a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
updateIdentityProviderRequest - InvalidParameterExceptionUnsupportedIdentityProviderExceptionResourceNotFoundExceptionConcurrentModificationExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.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 is set to the default value.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
updateResourceServerRequest - InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Allows a user to update a specific attribute (one at a time).
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
updateUserAttributesRequest - Represents the request to update user attributes.
ResourceNotFoundExceptionInvalidParameterExceptionCodeMismatchExceptionExpiredCodeExceptionNotAuthorizedExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionInvalidLambdaResponseExceptionTooManyRequestsExceptionAliasExistsExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionInvalidEmailRoleAccessPolicyExceptionCodeDeliveryFailureExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionForbiddenExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings using DescribeUserPool.
If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
updateUserPoolRequest - Represents the request to update the user pool.
ResourceNotFoundExceptionInvalidParameterExceptionConcurrentModificationExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserImportInProgressExceptionInternalErrorExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionUserPoolTaggingExceptionInvalidEmailRoleAccessPolicyExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.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 using DescribeUserPoolClient.
If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
You can also use this operation to enable token revocation for user pool clients. For more information about revoking tokens, see RevokeToken.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
updateUserPoolClientRequest - Represents the request to update the user pool client.
ResourceNotFoundExceptionInvalidParameterExceptionConcurrentModificationExceptionTooManyRequestsExceptionNotAuthorizedExceptionScopeDoesNotExistExceptionInvalidOAuthFlowExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.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 can't use it to change the domain for a user pool.
A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and sign-in pages for your application. When you set up a custom domain, you provide a certificate that you manage with Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain.
Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same, and your custom domain uses the new certificate automatically.
However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide this ARN to Amazon Cognito.
When you add your new certificate in ACM, you must choose US East (N. Virginia) as the Amazon Web Services Region.
After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain.
For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
updateUserPoolDomainRequest - The UpdateUserPoolDomain request input.
InvalidParameterExceptionNotAuthorizedExceptionResourceNotFoundExceptionTooManyRequestsExceptionInternalErrorExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Use this API to register a user's entered time-based one-time password (TOTP) code and mark the user's software token MFA status as "verified" if successful. The request takes an access token or a session string, but not both.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
verifySoftwareTokenRequest - InvalidParameterExceptionResourceNotFoundExceptionInvalidUserPoolConfigurationExceptionNotAuthorizedExceptionTooManyRequestsExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionEnableSoftwareTokenMFAExceptionNotAuthorizedExceptionSoftwareTokenMFANotFoundExceptionCodeMismatchExceptionForbiddenExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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 com.amazonaws.AmazonClientException, com.amazonaws.AmazonServiceException
Verifies the specified user attributes in the user pool.
If your user pool requires verification before Amazon Cognito updates the attribute value, VerifyUserAttribute updates the affected attribute to its pending value. For more information, see UserAttributeUpdateSettingsType.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
verifyUserAttributeRequest - Represents the request to verify user attributes.
ResourceNotFoundExceptionInvalidParameterExceptionCodeMismatchExceptionExpiredCodeExceptionNotAuthorizedExceptionTooManyRequestsExceptionLimitExceededExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAliasExistsExceptionForbiddenExceptioncom.amazonaws.AmazonClientException - 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.com.amazonaws.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()
com.amazonaws.ResponseMetadata getCachedResponseMetadata(com.amazonaws.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.