public class AmazonCognitoIdentityProviderClient extends com.amazonaws.AmazonWebServiceClient implements 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 | Field and Description |
|---|---|
protected java.util.List<com.amazonaws.transform.JsonErrorUnmarshaller> |
jsonErrorUnmarshallers
List of exception unmarshallers for all Amazon Cognito Your User Pool
exceptions.
|
| Constructor and Description |
|---|
AmazonCognitoIdentityProviderClient()
Deprecated.
|
AmazonCognitoIdentityProviderClient(com.amazonaws.auth.AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on
AmazonCognitoIdentityProvider using the specified AWS account
credentials.
|
AmazonCognitoIdentityProviderClient(com.amazonaws.auth.AWSCredentials awsCredentials,
com.amazonaws.ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonCognitoIdentityProvider using the specified AWS account credentials
and client configuration options.
|
AmazonCognitoIdentityProviderClient(com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on
AmazonCognitoIdentityProvider using the specified AWS account credentials
provider.
|
AmazonCognitoIdentityProviderClient(com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider,
com.amazonaws.ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonCognitoIdentityProvider using the specified AWS account credentials
provider and client configuration options.
|
AmazonCognitoIdentityProviderClient(com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider,
com.amazonaws.ClientConfiguration clientConfiguration,
com.amazonaws.http.HttpClient httpClient)
Constructs a new client to invoke service methods on
AmazonCognitoIdentityProvider using the specified AWS account credentials
provider, client configuration options and request metric collector.
|
AmazonCognitoIdentityProviderClient(com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider,
com.amazonaws.ClientConfiguration clientConfiguration,
com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)
Deprecated.
|
AmazonCognitoIdentityProviderClient(com.amazonaws.ClientConfiguration clientConfiguration)
Deprecated.
|
| 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)
Deprecated.
ResponseMetadata cache can hold up to 50 requests and
responses in memory and will cause memory issue. This method
now always returns null.
|
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.
|
SetLogDeliveryConfigurationResult |
setLogDeliveryConfiguration(SetLogDeliveryConfigurationRequest setLogDeliveryConfigurationRequest)
Sets up or modifies the detailed activity logging configuration of a user
pool.
|
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.
|
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.
|
addRequestHandler, addRequestHandler, configSigner, configSigner, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpoint, getEndpointPrefix, getRegions, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffsetclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion, shutdownprotected java.util.List<com.amazonaws.transform.JsonErrorUnmarshaller> jsonErrorUnmarshallers
@Deprecated public AmazonCognitoIdentityProviderClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AmazonCognitoIdentityProviderClient(com.amazonaws.ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling
how this client connects to AmazonCognitoIdentityProvider (ex:
proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChainpublic AmazonCognitoIdentityProviderClient(com.amazonaws.auth.AWSCredentials awsCredentials)
The client requests are authenticated using the AWSCredentials
provided in this constructor. Static AWSCredentials can be passed for
quick testing. However, it is strongly recommended to use Amazon Cognito
vended temporary credentials for use in production. This can be achieved
by using AWSMobileClient. Please see
https://aws-amplify.github.io/docs/android/authentication for
instructions on how to enable AWSMobileClient.
AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
@Override
public void onResult(final UserStateDetails details) {
AmazonCognitoIdentityProviderClient client = new AmazonCognitoIdentityProviderClient(
AWSMobileClient.getInstance());
}
@Override
public void onError(final Exception e) {
e.printStackTrace();
}
});
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key)
to use when authenticating with AWS services.public AmazonCognitoIdentityProviderClient(com.amazonaws.auth.AWSCredentials awsCredentials,
com.amazonaws.ClientConfiguration clientConfiguration)
The client requests are authenticated using the AWSCredentials
provided in this constructor. Static AWSCredentials can be passed for
quick testing. However, it is strongly recommended to use Amazon Cognito
vended temporary credentials for use in production. This can be achieved
by using AWSMobileClient. Please see
https://aws-amplify.github.io/docs/android/authentication for
instructions on how to enable AWSMobileClient.
AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
@Override
public void onResult(final UserStateDetails details) {
AmazonCognitoIdentityProviderClient client = new AmazonCognitoIdentityProviderClient(
AWSMobileClient.getInstance());
}
@Override
public void onError(final Exception e) {
e.printStackTrace();
}
});
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key)
to use when authenticating with AWS services.clientConfiguration - The client configuration options controlling
how this client connects to AmazonCognitoIdentityProvider (ex:
proxy settings, retry counts, etc.).public AmazonCognitoIdentityProviderClient(com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider)
The client requests are authenticated using the AWSCredentials
provided by the AWSCredentialsProvider. Static AWSCredentials can
be passed for quick testing. However, it is strongly recommended to use
Amazon Cognito vended temporary credentials for use in production. This
can be achieved by using AWSMobileClient. Please see
https://aws-amplify.github.io/docs/android/authentication for
instructions on how to enable AWSMobileClient.
AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
@Override
public void onResult(final UserStateDetails details) {
AmazonCognitoIdentityProviderClient client = new AmazonCognitoIdentityProviderClient(
AWSMobileClient.getInstance());
}
@Override
public void onError(final Exception e) {
e.printStackTrace();
}
});
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will
provide credentials to authenticate requests with AWS
services.public AmazonCognitoIdentityProviderClient(com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider,
com.amazonaws.ClientConfiguration clientConfiguration)
The client requests are authenticated using the AWSCredentials
provided by the AWSCredentialsProvider. Static AWSCredentials can
be passed for quick testing. However, it is strongly recommended to use
Amazon Cognito vended temporary credentials for use in production. This
can be achieved by using AWSMobileClient. Please see
https://aws-amplify.github.io/docs/android/authentication for
instructions on how to enable AWSMobileClient.
AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
@Override
public void onResult(final UserStateDetails details) {
AmazonCognitoIdentityProviderClient client = new AmazonCognitoIdentityProviderClient(
AWSMobileClient.getInstance());
}
@Override
public void onError(final Exception e) {
e.printStackTrace();
}
});
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will
provide credentials to authenticate requests with AWS
services.clientConfiguration - The client configuration options controlling
how this client connects to AmazonCognitoIdentityProvider (ex:
proxy settings, retry counts, etc.).@Deprecated
public AmazonCognitoIdentityProviderClient(com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider,
com.amazonaws.ClientConfiguration clientConfiguration,
com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will
provide credentials to authenticate requests with AWS
services.clientConfiguration - The client configuration options controlling
how this client connects to AmazonCognitoIdentityProvider (ex:
proxy settings, retry counts, etc.).requestMetricCollector - optional request metric collectorpublic AmazonCognitoIdentityProviderClient(com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider,
com.amazonaws.ClientConfiguration clientConfiguration,
com.amazonaws.http.HttpClient httpClient)
The client requests are authenticated using the AWSCredentials
provided by the AWSCredentialsProvider. Static AWSCredentials can
be passed for quick testing. However, it is strongly recommended to use
Amazon Cognito vended temporary credentials for use in production. This
can be achieved by using AWSMobileClient. Please see
https://aws-amplify.github.io/docs/android/authentication for
instructions on how to enable AWSMobileClient.
AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
@Override
public void onResult(final UserStateDetails details) {
AmazonCognitoIdentityProviderClient client = new AmazonCognitoIdentityProviderClient(
AWSMobileClient.getInstance());
}
@Override
public void onError(final Exception e) {
e.printStackTrace();
}
});
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will
provide credentials to authenticate requests with AWS
services.clientConfiguration - The client configuration options controlling
how this client connects to AmazonCognitoIdentityProvider (ex:
proxy settings, retry counts, etc.).httpClient - A http clientpublic AddCustomAttributesResult addCustomAttributes(AddCustomAttributesRequest addCustomAttributesRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
addCustomAttributes in interface AmazonCognitoIdentityProvideraddCustomAttributesRequest - 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.public void adminAddUserToGroup(AdminAddUserToGroupRequest adminAddUserToGroupRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
adminAddUserToGroup in interface AmazonCognitoIdentityProvideradminAddUserToGroupRequest - 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.public AdminConfirmSignUpResult adminConfirmSignUp(AdminConfirmSignUpRequest adminConfirmSignUpRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
adminConfirmSignUp in interface AmazonCognitoIdentityProvideradminConfirmSignUpRequest - 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.public AdminCreateUserResult adminCreateUser(AdminCreateUserRequest adminCreateUserRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
adminCreateUser in interface AmazonCognitoIdentityProvideradminCreateUserRequest - 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.public void adminDeleteUser(AdminDeleteUserRequest adminDeleteUserRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
adminDeleteUser in interface AmazonCognitoIdentityProvideradminDeleteUserRequest - 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.public AdminDeleteUserAttributesResult adminDeleteUserAttributes(AdminDeleteUserAttributesRequest adminDeleteUserAttributesRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
adminDeleteUserAttributes in interface AmazonCognitoIdentityProvideradminDeleteUserAttributesRequest - 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.public AdminDisableProviderForUserResult adminDisableProviderForUser(AdminDisableProviderForUserRequest adminDisableProviderForUserRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
adminDisableProviderForUser in interface AmazonCognitoIdentityProvideradminDisableProviderForUserRequest - 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.public AdminDisableUserResult adminDisableUser(AdminDisableUserRequest adminDisableUserRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
adminDisableUser in interface AmazonCognitoIdentityProvideradminDisableUserRequest - 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.public AdminEnableUserResult adminEnableUser(AdminEnableUserRequest adminEnableUserRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
adminEnableUser in interface AmazonCognitoIdentityProvideradminEnableUserRequest - 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.public void adminForgetDevice(AdminForgetDeviceRequest adminForgetDeviceRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
adminForgetDevice in interface AmazonCognitoIdentityProvideradminForgetDeviceRequest - 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.public AdminGetDeviceResult adminGetDevice(AdminGetDeviceRequest adminGetDeviceRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
adminGetDevice in interface AmazonCognitoIdentityProvideradminGetDeviceRequest - 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.public AdminGetUserResult adminGetUser(AdminGetUserRequest adminGetUserRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
adminGetUser in interface AmazonCognitoIdentityProvideradminGetUserRequest - 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.public AdminInitiateAuthResult adminInitiateAuth(AdminInitiateAuthRequest adminInitiateAuthRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
adminInitiateAuth in interface AmazonCognitoIdentityProvideradminInitiateAuthRequest - 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.public AdminLinkProviderForUserResult adminLinkProviderForUser(AdminLinkProviderForUserRequest adminLinkProviderForUserRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
adminLinkProviderForUser in interface AmazonCognitoIdentityProvideradminLinkProviderForUserRequest - 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.public AdminListDevicesResult adminListDevices(AdminListDevicesRequest adminListDevicesRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
adminListDevices in interface AmazonCognitoIdentityProvideradminListDevicesRequest - 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.public AdminListGroupsForUserResult adminListGroupsForUser(AdminListGroupsForUserRequest adminListGroupsForUserRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
adminListGroupsForUser in interface AmazonCognitoIdentityProvideradminListGroupsForUserRequest - 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.public AdminListUserAuthEventsResult adminListUserAuthEvents(AdminListUserAuthEventsRequest adminListUserAuthEventsRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
adminListUserAuthEvents in interface AmazonCognitoIdentityProvideradminListUserAuthEventsRequest - 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.public void adminRemoveUserFromGroup(AdminRemoveUserFromGroupRequest adminRemoveUserFromGroupRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
adminRemoveUserFromGroup in interface AmazonCognitoIdentityProvideradminRemoveUserFromGroupRequest - 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.public AdminResetUserPasswordResult adminResetUserPassword(AdminResetUserPasswordRequest adminResetUserPasswordRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
adminResetUserPassword in interface AmazonCognitoIdentityProvideradminResetUserPasswordRequest - 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.public AdminRespondToAuthChallengeResult adminRespondToAuthChallenge(AdminRespondToAuthChallengeRequest adminRespondToAuthChallengeRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
adminRespondToAuthChallenge in interface AmazonCognitoIdentityProvideradminRespondToAuthChallengeRequest - 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.public AdminSetUserMFAPreferenceResult adminSetUserMFAPreference(AdminSetUserMFAPreferenceRequest adminSetUserMFAPreferenceRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
adminSetUserMFAPreference in interface AmazonCognitoIdentityProvideradminSetUserMFAPreferenceRequest - 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.public AdminSetUserPasswordResult adminSetUserPassword(AdminSetUserPasswordRequest adminSetUserPasswordRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
adminSetUserPassword in interface AmazonCognitoIdentityProvideradminSetUserPasswordRequest - 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.public AdminSetUserSettingsResult adminSetUserSettings(AdminSetUserSettingsRequest adminSetUserSettingsRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
adminSetUserSettings in interface AmazonCognitoIdentityProvideradminSetUserSettingsRequest - 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.public AdminUpdateAuthEventFeedbackResult adminUpdateAuthEventFeedback(AdminUpdateAuthEventFeedbackRequest adminUpdateAuthEventFeedbackRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
adminUpdateAuthEventFeedback in interface AmazonCognitoIdentityProvideradminUpdateAuthEventFeedbackRequest - 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.public AdminUpdateDeviceStatusResult adminUpdateDeviceStatus(AdminUpdateDeviceStatusRequest adminUpdateDeviceStatusRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
adminUpdateDeviceStatus in interface AmazonCognitoIdentityProvideradminUpdateDeviceStatusRequest - 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.public AdminUpdateUserAttributesResult adminUpdateUserAttributes(AdminUpdateUserAttributesRequest adminUpdateUserAttributesRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
adminUpdateUserAttributes in interface AmazonCognitoIdentityProvideradminUpdateUserAttributesRequest - 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.public AdminUserGlobalSignOutResult adminUserGlobalSignOut(AdminUserGlobalSignOutRequest adminUserGlobalSignOutRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
adminUserGlobalSignOut in interface AmazonCognitoIdentityProvideradminUserGlobalSignOutRequest - 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.public AssociateSoftwareTokenResult associateSoftwareToken(AssociateSoftwareTokenRequest associateSoftwareTokenRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
associateSoftwareToken in interface AmazonCognitoIdentityProviderassociateSoftwareTokenRequest - 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.public ChangePasswordResult changePassword(ChangePasswordRequest changePasswordRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
changePassword in interface AmazonCognitoIdentityProviderchangePasswordRequest - 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.public ConfirmDeviceResult confirmDevice(ConfirmDeviceRequest confirmDeviceRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
confirmDevice in interface AmazonCognitoIdentityProviderconfirmDeviceRequest - 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.public ConfirmForgotPasswordResult confirmForgotPassword(ConfirmForgotPasswordRequest confirmForgotPasswordRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
confirmForgotPassword in interface AmazonCognitoIdentityProviderconfirmForgotPasswordRequest - 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.public ConfirmSignUpResult confirmSignUp(ConfirmSignUpRequest confirmSignUpRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
confirmSignUp in interface AmazonCognitoIdentityProviderconfirmSignUpRequest - 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.public CreateGroupResult createGroup(CreateGroupRequest createGroupRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
createGroup in interface AmazonCognitoIdentityProvidercreateGroupRequest - 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.public CreateIdentityProviderResult createIdentityProvider(CreateIdentityProviderRequest createIdentityProviderRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
createIdentityProvider in interface AmazonCognitoIdentityProvidercreateIdentityProviderRequest - 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.public CreateResourceServerResult createResourceServer(CreateResourceServerRequest createResourceServerRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
createResourceServer in interface AmazonCognitoIdentityProvidercreateResourceServerRequest - 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.public CreateUserImportJobResult createUserImportJob(CreateUserImportJobRequest createUserImportJobRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
createUserImportJob in interface AmazonCognitoIdentityProvidercreateUserImportJobRequest - 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.public CreateUserPoolResult createUserPool(CreateUserPoolRequest createUserPoolRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
createUserPool in interface AmazonCognitoIdentityProvidercreateUserPoolRequest - 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.public CreateUserPoolClientResult createUserPoolClient(CreateUserPoolClientRequest createUserPoolClientRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
createUserPoolClient in interface AmazonCognitoIdentityProvidercreateUserPoolClientRequest - 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.public CreateUserPoolDomainResult createUserPoolDomain(CreateUserPoolDomainRequest createUserPoolDomainRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
createUserPoolDomain in interface AmazonCognitoIdentityProvidercreateUserPoolDomainRequest - 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.public void deleteGroup(DeleteGroupRequest deleteGroupRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
Deletes a group.
Calling this action requires developer credentials.
deleteGroup in interface AmazonCognitoIdentityProviderdeleteGroupRequest - 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.public void deleteIdentityProvider(DeleteIdentityProviderRequest deleteIdentityProviderRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
Deletes an IdP for a user pool.
deleteIdentityProvider in interface AmazonCognitoIdentityProviderdeleteIdentityProviderRequest - 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.public void deleteResourceServer(DeleteResourceServerRequest deleteResourceServerRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
Deletes a resource server.
deleteResourceServer in interface AmazonCognitoIdentityProviderdeleteResourceServerRequest - 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.public void deleteUser(DeleteUserRequest deleteUserRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
deleteUser in interface AmazonCognitoIdentityProviderdeleteUserRequest - 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.public DeleteUserAttributesResult deleteUserAttributes(DeleteUserAttributesRequest deleteUserAttributesRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
deleteUserAttributes in interface AmazonCognitoIdentityProviderdeleteUserAttributesRequest - 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.public void deleteUserPool(DeleteUserPoolRequest deleteUserPoolRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
Deletes the specified Amazon Cognito user pool.
deleteUserPool in interface AmazonCognitoIdentityProviderdeleteUserPoolRequest - 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.public void deleteUserPoolClient(DeleteUserPoolClientRequest deleteUserPoolClientRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
Allows the developer to delete the user pool client.
deleteUserPoolClient in interface AmazonCognitoIdentityProviderdeleteUserPoolClientRequest - 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.public DeleteUserPoolDomainResult deleteUserPoolDomain(DeleteUserPoolDomainRequest deleteUserPoolDomainRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
Deletes a domain for a user pool.
deleteUserPoolDomain in interface AmazonCognitoIdentityProviderdeleteUserPoolDomainRequest - 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.public DescribeIdentityProviderResult describeIdentityProvider(DescribeIdentityProviderRequest describeIdentityProviderRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
Gets information about a specific IdP.
describeIdentityProvider in interface AmazonCognitoIdentityProviderdescribeIdentityProviderRequest - 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.public DescribeResourceServerResult describeResourceServer(DescribeResourceServerRequest describeResourceServerRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
Describes a resource server.
describeResourceServer in interface AmazonCognitoIdentityProviderdescribeResourceServerRequest - 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.public DescribeRiskConfigurationResult describeRiskConfiguration(DescribeRiskConfigurationRequest describeRiskConfigurationRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
Describes the risk configuration.
describeRiskConfiguration in interface AmazonCognitoIdentityProviderdescribeRiskConfigurationRequest - 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.public DescribeUserImportJobResult describeUserImportJob(DescribeUserImportJobRequest describeUserImportJobRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
Describes the user import job.
describeUserImportJob in interface AmazonCognitoIdentityProviderdescribeUserImportJobRequest - 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.public DescribeUserPoolResult describeUserPool(DescribeUserPoolRequest describeUserPoolRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
describeUserPool in interface AmazonCognitoIdentityProviderdescribeUserPoolRequest - 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.public DescribeUserPoolClientResult describeUserPoolClient(DescribeUserPoolClientRequest describeUserPoolClientRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
describeUserPoolClient in interface AmazonCognitoIdentityProviderdescribeUserPoolClientRequest - 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.public DescribeUserPoolDomainResult describeUserPoolDomain(DescribeUserPoolDomainRequest describeUserPoolDomainRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
Gets information about a domain.
describeUserPoolDomain in interface AmazonCognitoIdentityProviderdescribeUserPoolDomainRequest - 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.public void forgetDevice(ForgetDeviceRequest forgetDeviceRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
forgetDevice in interface AmazonCognitoIdentityProviderforgetDeviceRequest - 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.public ForgotPasswordResult forgotPassword(ForgotPasswordRequest forgotPasswordRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
forgotPassword in interface AmazonCognitoIdentityProviderforgotPasswordRequest - 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.public GetCSVHeaderResult getCSVHeader(GetCSVHeaderRequest getCSVHeaderRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
Gets the header information for the comma-separated value (CSV) file to be used as input for the user import job.
getCSVHeader in interface AmazonCognitoIdentityProvidergetCSVHeaderRequest - 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.public GetDeviceResult getDevice(GetDeviceRequest getDeviceRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
getDevice in interface AmazonCognitoIdentityProvidergetDeviceRequest - 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.public GetGroupResult getGroup(GetGroupRequest getGroupRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
Gets a group.
Calling this action requires developer credentials.
getGroup in interface AmazonCognitoIdentityProvidergetGroupRequest - 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.public GetIdentityProviderByIdentifierResult getIdentityProviderByIdentifier(GetIdentityProviderByIdentifierRequest getIdentityProviderByIdentifierRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
Gets the specified IdP.
getIdentityProviderByIdentifier in interface AmazonCognitoIdentityProvidergetIdentityProviderByIdentifierRequest - 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.public GetLogDeliveryConfigurationResult getLogDeliveryConfiguration(GetLogDeliveryConfigurationRequest getLogDeliveryConfigurationRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
Gets the detailed activity logging configuration for a user pool.
getLogDeliveryConfiguration in interface AmazonCognitoIdentityProvidergetLogDeliveryConfigurationRequest - 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.public GetSigningCertificateResult getSigningCertificate(GetSigningCertificateRequest getSigningCertificateRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
getSigningCertificate in interface AmazonCognitoIdentityProvidergetSigningCertificateRequest - 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.public GetUICustomizationResult getUICustomization(GetUICustomizationRequest getUICustomizationRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
getUICustomization in interface AmazonCognitoIdentityProvidergetUICustomizationRequest - 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.public GetUserResult getUser(GetUserRequest getUserRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
getUser in interface AmazonCognitoIdentityProvidergetUserRequest - 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.public GetUserAttributeVerificationCodeResult getUserAttributeVerificationCode(GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
getUserAttributeVerificationCode in interface AmazonCognitoIdentityProvidergetUserAttributeVerificationCodeRequest - 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.public GetUserPoolMfaConfigResult getUserPoolMfaConfig(GetUserPoolMfaConfigRequest getUserPoolMfaConfigRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
Gets the user pool multi-factor authentication (MFA) configuration.
getUserPoolMfaConfig in interface AmazonCognitoIdentityProvidergetUserPoolMfaConfigRequest - 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.public GlobalSignOutResult globalSignOut(GlobalSignOutRequest globalSignOutRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
globalSignOut in interface AmazonCognitoIdentityProviderglobalSignOutRequest - 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.public InitiateAuthResult initiateAuth(InitiateAuthRequest initiateAuthRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
initiateAuth in interface AmazonCognitoIdentityProviderinitiateAuthRequest - 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.public ListDevicesResult listDevices(ListDevicesRequest listDevicesRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
listDevices in interface AmazonCognitoIdentityProviderlistDevicesRequest - 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.public ListGroupsResult listGroups(ListGroupsRequest listGroupsRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
listGroups in interface AmazonCognitoIdentityProviderlistGroupsRequest - 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.public ListIdentityProvidersResult listIdentityProviders(ListIdentityProvidersRequest listIdentityProvidersRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
listIdentityProviders in interface AmazonCognitoIdentityProviderlistIdentityProvidersRequest - 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.public ListResourceServersResult listResourceServers(ListResourceServersRequest listResourceServersRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
listResourceServers in interface AmazonCognitoIdentityProviderlistResourceServersRequest - 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.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
listTagsForResource in interface AmazonCognitoIdentityProviderlistTagsForResourceRequest - 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.public ListUserImportJobsResult listUserImportJobs(ListUserImportJobsRequest listUserImportJobsRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
listUserImportJobs in interface AmazonCognitoIdentityProviderlistUserImportJobsRequest - 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.public ListUserPoolClientsResult listUserPoolClients(ListUserPoolClientsRequest listUserPoolClientsRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
listUserPoolClients in interface AmazonCognitoIdentityProviderlistUserPoolClientsRequest - 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.public ListUserPoolsResult listUserPools(ListUserPoolsRequest listUserPoolsRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
listUserPools in interface AmazonCognitoIdentityProviderlistUserPoolsRequest - 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.public ListUsersResult listUsers(ListUsersRequest listUsersRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
listUsers in interface AmazonCognitoIdentityProviderlistUsersRequest - 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.public ListUsersInGroupResult listUsersInGroup(ListUsersInGroupRequest listUsersInGroupRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
listUsersInGroup in interface AmazonCognitoIdentityProviderlistUsersInGroupRequest - 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.public ResendConfirmationCodeResult resendConfirmationCode(ResendConfirmationCodeRequest resendConfirmationCodeRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
resendConfirmationCode in interface AmazonCognitoIdentityProviderresendConfirmationCodeRequest - 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.public RespondToAuthChallengeResult respondToAuthChallenge(RespondToAuthChallengeRequest respondToAuthChallengeRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
respondToAuthChallenge in interface AmazonCognitoIdentityProviderrespondToAuthChallengeRequest - 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.public RevokeTokenResult revokeToken(RevokeTokenRequest revokeTokenRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
revokeToken in interface AmazonCognitoIdentityProviderrevokeTokenRequest - 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.public SetLogDeliveryConfigurationResult setLogDeliveryConfiguration(SetLogDeliveryConfigurationRequest setLogDeliveryConfigurationRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
Sets up or modifies the detailed activity logging configuration of a user pool.
setLogDeliveryConfiguration in interface AmazonCognitoIdentityProvidersetLogDeliveryConfigurationRequest - 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.public SetRiskConfigurationResult setRiskConfiguration(SetRiskConfigurationRequest setRiskConfigurationRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
setRiskConfiguration in interface AmazonCognitoIdentityProvidersetRiskConfigurationRequest - 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.public SetUICustomizationResult setUICustomization(SetUICustomizationRequest setUICustomizationRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
setUICustomization in interface AmazonCognitoIdentityProvidersetUICustomizationRequest - 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.public SetUserMFAPreferenceResult setUserMFAPreference(SetUserMFAPreferenceRequest setUserMFAPreferenceRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
setUserMFAPreference in interface AmazonCognitoIdentityProvidersetUserMFAPreferenceRequest - 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.public SetUserPoolMfaConfigResult setUserPoolMfaConfig(SetUserPoolMfaConfigRequest setUserPoolMfaConfigRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
setUserPoolMfaConfig in interface AmazonCognitoIdentityProvidersetUserPoolMfaConfigRequest - 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.public SetUserSettingsResult setUserSettings(SetUserSettingsRequest setUserSettingsRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
setUserSettings in interface AmazonCognitoIdentityProvidersetUserSettingsRequest - 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.public SignUpResult signUp(SignUpRequest signUpRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
signUp in interface AmazonCognitoIdentityProvidersignUpRequest - 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.public StartUserImportJobResult startUserImportJob(StartUserImportJobRequest startUserImportJobRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
Starts the user import.
startUserImportJob in interface AmazonCognitoIdentityProviderstartUserImportJobRequest - 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.public StopUserImportJobResult stopUserImportJob(StopUserImportJobRequest stopUserImportJobRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
Stops the user import job.
stopUserImportJob in interface AmazonCognitoIdentityProviderstopUserImportJobRequest - 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.public TagResourceResult tagResource(TagResourceRequest tagResourceRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
tagResource in interface AmazonCognitoIdentityProvidertagResourceRequest - 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.public UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account.
untagResource in interface AmazonCognitoIdentityProvideruntagResourceRequest - 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.public UpdateAuthEventFeedbackResult updateAuthEventFeedback(UpdateAuthEventFeedbackRequest updateAuthEventFeedbackRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
updateAuthEventFeedback in interface AmazonCognitoIdentityProviderupdateAuthEventFeedbackRequest - 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.public UpdateDeviceStatusResult updateDeviceStatus(UpdateDeviceStatusRequest updateDeviceStatusRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
updateDeviceStatus in interface AmazonCognitoIdentityProviderupdateDeviceStatusRequest - 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.public UpdateGroupResult updateGroup(UpdateGroupRequest updateGroupRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
updateGroup in interface AmazonCognitoIdentityProviderupdateGroupRequest - 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.public UpdateIdentityProviderResult updateIdentityProvider(UpdateIdentityProviderRequest updateIdentityProviderRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
updateIdentityProvider in interface AmazonCognitoIdentityProviderupdateIdentityProviderRequest - 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.public UpdateResourceServerResult updateResourceServer(UpdateResourceServerRequest updateResourceServerRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
updateResourceServer in interface AmazonCognitoIdentityProviderupdateResourceServerRequest - 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.public UpdateUserAttributesResult updateUserAttributes(UpdateUserAttributesRequest updateUserAttributesRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
updateUserAttributes in interface AmazonCognitoIdentityProviderupdateUserAttributesRequest - 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.public UpdateUserPoolResult updateUserPool(UpdateUserPoolRequest updateUserPoolRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
updateUserPool in interface AmazonCognitoIdentityProviderupdateUserPoolRequest - 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.public UpdateUserPoolClientResult updateUserPoolClient(UpdateUserPoolClientRequest updateUserPoolClientRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
updateUserPoolClient in interface AmazonCognitoIdentityProviderupdateUserPoolClientRequest - 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.public UpdateUserPoolDomainResult updateUserPoolDomain(UpdateUserPoolDomainRequest updateUserPoolDomainRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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
updateUserPoolDomain in interface AmazonCognitoIdentityProviderupdateUserPoolDomainRequest - 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.public VerifySoftwareTokenResult verifySoftwareToken(VerifySoftwareTokenRequest verifySoftwareTokenRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
verifySoftwareToken in interface AmazonCognitoIdentityProviderverifySoftwareTokenRequest - 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.public VerifyUserAttributeResult verifyUserAttribute(VerifyUserAttributeRequest verifyUserAttributeRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
verifyUserAttribute in interface AmazonCognitoIdentityProviderverifyUserAttributeRequest - 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.@Deprecated public 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 the request.
getCachedResponseMetadata in interface AmazonCognitoIdentityProviderrequest - The originally executed request