public class AmazonCognitoIdentityProviderClient extends AmazonWebServiceClient implements AmazonCognitoIdentityProvider
Using the Amazon Cognito User Pools API, you can create a user pool to manage directories and users. You can authenticate a user to obtain tokens related to user identity and access policies.
This API reference provides information about user pools in Amazon Cognito User Pools.
For more information, see the Amazon Cognito Documentation.
| Modifier and Type | Field and Description |
|---|---|
protected List<com.amazonaws.transform.JsonErrorUnmarshaller> |
jsonErrorUnmarshallers
List of exception unmarshallers for all Amazon Cognito Your User Pool
exceptions.
|
client, clientConfiguration, endpoint, endpointPrefix, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset| Constructor and Description |
|---|
AmazonCognitoIdentityProviderClient()
Deprecated.
|
AmazonCognitoIdentityProviderClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on
AmazonCognitoIdentityProvider using the specified AWS account
credentials.
|
AmazonCognitoIdentityProviderClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonCognitoIdentityProvider using the specified AWS account credentials
and client configuration options.
|
AmazonCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on
AmazonCognitoIdentityProvider using the specified AWS account credentials
provider.
|
AmazonCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonCognitoIdentityProvider using the specified AWS account credentials
provider and client configuration options.
|
AmazonCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
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(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
Deprecated.
|
AmazonCognitoIdentityProviderClient(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)
Disables the user from signing in with the specified external (SAML or
social) identity provider.
|
AdminDisableUserResult |
adminDisableUser(AdminDisableUserRequest adminDisableUserRequest)
Disables the specified user.
|
AdminEnableUserResult |
adminEnableUser(AdminEnableUserRequest adminEnableUserRequest)
Enables the specified user as an administrator.
|
void |
adminForgetDevice(AdminForgetDeviceRequest adminForgetDeviceRequest)
Forgets the device, as an administrator.
|
AdminGetDeviceResult |
adminGetDevice(AdminGetDeviceRequest adminGetDeviceRequest)
Gets the device, as an administrator.
|
AdminGetUserResult |
adminGetUser(AdminGetUserRequest adminGetUserRequest)
Gets the specified user by user name in a user pool as an administrator.
|
AdminInitiateAuthResult |
adminInitiateAuth(AdminInitiateAuthRequest adminInitiateAuthRequest)
Initiates the authentication flow, as an administrator.
|
AdminLinkProviderForUserResult |
adminLinkProviderForUser(AdminLinkProviderForUserRequest adminLinkProviderForUserRequest)
Links an existing user account in a user pool (
DestinationUser) to an identity from an external identity
provider (SourceUser) based on a specified attribute name
and value from the external identity provider. |
AdminListDevicesResult |
adminListDevices(AdminListDevicesRequest adminListDevicesRequest)
Lists devices, as an administrator.
|
AdminListGroupsForUserResult |
adminListGroupsForUser(AdminListGroupsForUserRequest adminListGroupsForUserRequest)
Lists the groups that the user belongs to.
|
AdminListUserAuthEventsResult |
adminListUserAuthEvents(AdminListUserAuthEventsRequest adminListUserAuthEventsRequest)
Lists a history of user activity and any risks detected as part of Amazon
Cognito advanced security.
|
void |
adminRemoveUserFromGroup(AdminRemoveUserFromGroupRequest adminRemoveUserFromGroupRequest)
Removes the specified user from the specified group.
|
AdminResetUserPasswordResult |
adminResetUserPassword(AdminResetUserPasswordRequest adminResetUserPasswordRequest)
Resets the specified user's password in a user pool as an administrator.
|
AdminRespondToAuthChallengeResult |
adminRespondToAuthChallenge(AdminRespondToAuthChallengeRequest adminRespondToAuthChallengeRequest)
Responds to an authentication challenge, as an administrator.
|
AdminSetUserMFAPreferenceResult |
adminSetUserMFAPreference(AdminSetUserMFAPreferenceRequest adminSetUserMFAPreferenceRequest)
Sets the user's multi-factor authentication (MFA) preference, including
which MFA options are enabled and if any are preferred.
|
AdminSetUserPasswordResult |
adminSetUserPassword(AdminSetUserPasswordRequest adminSetUserPasswordRequest)
Sets the specified user's password in a user pool as an administrator.
|
AdminSetUserSettingsResult |
adminSetUserSettings(AdminSetUserSettingsRequest adminSetUserSettingsRequest)
This action is no longer supported. You can use it to configure
only SMS MFA.
|
AdminUpdateAuthEventFeedbackResult |
adminUpdateAuthEventFeedback(AdminUpdateAuthEventFeedbackRequest adminUpdateAuthEventFeedbackRequest)
Provides feedback for an authentication event as to whether it was from a
valid user.
|
AdminUpdateDeviceStatusResult |
adminUpdateDeviceStatus(AdminUpdateDeviceStatusRequest adminUpdateDeviceStatusRequest)
Updates the device status as an administrator.
|
AdminUpdateUserAttributesResult |
adminUpdateUserAttributes(AdminUpdateUserAttributesRequest adminUpdateUserAttributesRequest)
Updates the specified user's attributes, including developer attributes,
as an administrator.
|
AdminUserGlobalSignOutResult |
adminUserGlobalSignOut(AdminUserGlobalSignOutRequest adminUserGlobalSignOutRequest)
Signs out users from all devices, as an administrator.
|
AssociateSoftwareTokenResult |
associateSoftwareToken(AssociateSoftwareTokenRequest associateSoftwareTokenRequest)
Returns a unique generated shared secret key code for the user account.
|
ChangePasswordResult |
changePassword(ChangePasswordRequest changePasswordRequest)
Changes the password for a specified user in a user pool.
|
ConfirmDeviceResult |
confirmDevice(ConfirmDeviceRequest confirmDeviceRequest)
Confirms tracking of the device.
|
ConfirmForgotPasswordResult |
confirmForgotPassword(ConfirmForgotPasswordRequest confirmForgotPasswordRequest)
Allows a user to enter a confirmation code to reset a forgotten password.
|
ConfirmSignUpResult |
confirmSignUp(ConfirmSignUpRequest confirmSignUpRequest)
Confirms registration of a user and handles the existing alias from a
previous user.
|
CreateGroupResult |
createGroup(CreateGroupRequest createGroupRequest)
Creates a new group in the specified user pool.
|
CreateIdentityProviderResult |
createIdentityProvider(CreateIdentityProviderRequest createIdentityProviderRequest)
Creates an identity provider for a user pool.
|
CreateResourceServerResult |
createResourceServer(CreateResourceServerRequest createResourceServerRequest)
Creates a new OAuth2.0 resource server and defines custom scopes in it.
|
CreateUserImportJobResult |
createUserImportJob(CreateUserImportJobRequest createUserImportJobRequest)
Creates the user import job.
|
CreateUserPoolResult |
createUserPool(CreateUserPoolRequest createUserPoolRequest)
Creates a new Amazon Cognito user pool and sets the password policy for
the pool.
|
CreateUserPoolClientResult |
createUserPoolClient(CreateUserPoolClientRequest createUserPoolClientRequest)
Creates the user pool client.
|
CreateUserPoolDomainResult |
createUserPoolDomain(CreateUserPoolDomainRequest createUserPoolDomainRequest)
Creates a new domain for a user pool.
|
void |
deleteGroup(DeleteGroupRequest deleteGroupRequest)
Deletes a group.
|
void |
deleteIdentityProvider(DeleteIdentityProviderRequest deleteIdentityProviderRequest)
Deletes an identity provider for a user pool.
|
void |
deleteResourceServer(DeleteResourceServerRequest deleteResourceServerRequest)
Deletes a resource server.
|
void |
deleteUser(DeleteUserRequest deleteUserRequest)
Allows a user to delete himself or herself.
|
DeleteUserAttributesResult |
deleteUserAttributes(DeleteUserAttributesRequest deleteUserAttributesRequest)
Deletes the attributes for a user.
|
void |
deleteUserPool(DeleteUserPoolRequest deleteUserPoolRequest)
Deletes the specified Amazon Cognito user pool.
|
void |
deleteUserPoolClient(DeleteUserPoolClientRequest deleteUserPoolClientRequest)
Allows the developer to delete the user pool client.
|
DeleteUserPoolDomainResult |
deleteUserPoolDomain(DeleteUserPoolDomainRequest deleteUserPoolDomainRequest)
Deletes a domain for a user pool.
|
DescribeIdentityProviderResult |
describeIdentityProvider(DescribeIdentityProviderRequest describeIdentityProviderRequest)
Gets information about a specific identity provider.
|
DescribeResourceServerResult |
describeResourceServer(DescribeResourceServerRequest describeResourceServerRequest)
Describes a resource server.
|
DescribeRiskConfigurationResult |
describeRiskConfiguration(DescribeRiskConfigurationRequest describeRiskConfigurationRequest)
Describes the risk configuration.
|
DescribeUserImportJobResult |
describeUserImportJob(DescribeUserImportJobRequest describeUserImportJobRequest)
Describes the user import job.
|
DescribeUserPoolResult |
describeUserPool(DescribeUserPoolRequest describeUserPoolRequest)
Returns the configuration information and metadata of the specified user
pool.
|
DescribeUserPoolClientResult |
describeUserPoolClient(DescribeUserPoolClientRequest describeUserPoolClientRequest)
Client method for returning the configuration information and metadata of
the specified user pool app client.
|
DescribeUserPoolDomainResult |
describeUserPoolDomain(DescribeUserPoolDomainRequest describeUserPoolDomainRequest)
Gets information about a domain.
|
void |
forgetDevice(ForgetDeviceRequest forgetDeviceRequest)
Forgets the specified device.
|
ForgotPasswordResult |
forgotPassword(ForgotPasswordRequest forgotPasswordRequest)
Calling this API causes a message to be sent to the end user with a
confirmation code that is required to change the user's password.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
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 .csv file to be used as input for the
user import job.
|
GetDeviceResult |
getDevice(GetDeviceRequest getDeviceRequest)
Gets the device.
|
GetGroupResult |
getGroup(GetGroupRequest getGroupRequest)
Gets a group.
|
GetIdentityProviderByIdentifierResult |
getIdentityProviderByIdentifier(GetIdentityProviderByIdentifierRequest getIdentityProviderByIdentifierRequest)
Gets the specified identity provider.
|
GetSigningCertificateResult |
getSigningCertificate(GetSigningCertificateRequest getSigningCertificateRequest)
This method takes a user pool ID, and returns the signing certificate.
|
GetUICustomizationResult |
getUICustomization(GetUICustomizationRequest getUICustomizationRequest)
Gets the UI Customization information for a particular app client's app
UI, if there is something set.
|
GetUserResult |
getUser(GetUserRequest getUserRequest)
Gets the user attributes and metadata for a user.
|
GetUserAttributeVerificationCodeResult |
getUserAttributeVerificationCode(GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest)
Gets the user attribute verification code for the specified attribute
name.
|
GetUserPoolMfaConfigResult |
getUserPoolMfaConfig(GetUserPoolMfaConfigRequest getUserPoolMfaConfigRequest)
Gets the user pool multi-factor authentication (MFA) configuration.
|
GlobalSignOutResult |
globalSignOut(GlobalSignOutRequest globalSignOutRequest)
Signs out users from all devices.
|
InitiateAuthResult |
initiateAuth(InitiateAuthRequest initiateAuthRequest)
Initiates the authentication flow.
|
ListDevicesResult |
listDevices(ListDevicesRequest listDevicesRequest)
Lists the devices.
|
ListGroupsResult |
listGroups(ListGroupsRequest listGroupsRequest)
Lists the groups associated with a user pool.
|
ListIdentityProvidersResult |
listIdentityProviders(ListIdentityProvidersRequest listIdentityProvidersRequest)
Lists information about all identity providers for a user pool.
|
ListResourceServersResult |
listResourceServers(ListResourceServersRequest listResourceServersRequest)
Lists the resource servers for a user pool.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags that are assigned to an Amazon Cognito user pool.
|
ListUserImportJobsResult |
listUserImportJobs(ListUserImportJobsRequest listUserImportJobsRequest)
Lists the user import jobs.
|
ListUserPoolClientsResult |
listUserPoolClients(ListUserPoolClientsRequest listUserPoolClientsRequest)
Lists the clients that have been created for the specified user pool.
|
ListUserPoolsResult |
listUserPools(ListUserPoolsRequest listUserPoolsRequest)
Lists the user pools associated with an AWS account.
|
ListUsersResult |
listUsers(ListUsersRequest listUsersRequest)
Lists the users in the Amazon Cognito user pool.
|
ListUsersInGroupResult |
listUsersInGroup(ListUsersInGroupRequest listUsersInGroupRequest)
Lists the users in the specified group.
|
ResendConfirmationCodeResult |
resendConfirmationCode(ResendConfirmationCodeRequest resendConfirmationCodeRequest)
Resends the confirmation (for confirmation of registration) to a specific
user in the user pool.
|
RespondToAuthChallengeResult |
respondToAuthChallenge(RespondToAuthChallengeRequest respondToAuthChallengeRequest)
Responds to the authentication challenge.
|
SetRiskConfigurationResult |
setRiskConfiguration(SetRiskConfigurationRequest setRiskConfigurationRequest)
Configures actions on detected risks.
|
SetUICustomizationResult |
setUICustomization(SetUICustomizationRequest setUICustomizationRequest)
Sets the UI customization information for a user pool's built-in app UI.
|
SetUserMFAPreferenceResult |
setUserMFAPreference(SetUserMFAPreferenceRequest setUserMFAPreferenceRequest)
Set the user's multi-factor authentication (MFA) method preference,
including which MFA factors are enabled and if any are preferred.
|
SetUserPoolMfaConfigResult |
setUserPoolMfaConfig(SetUserPoolMfaConfigRequest setUserPoolMfaConfigRequest)
Set the user pool multi-factor authentication (MFA) configuration.
|
SetUserSettingsResult |
setUserSettings(SetUserSettingsRequest setUserSettingsRequest)
This action is no longer supported. You can use it to configure
only SMS MFA.
|
SignUpResult |
signUp(SignUpRequest signUpRequest)
Registers the user in the specified user pool and creates a user name,
password, and user attributes.
|
StartUserImportJobResult |
startUserImportJob(StartUserImportJobRequest startUserImportJobRequest)
Starts the user import.
|
StopUserImportJobResult |
stopUserImportJob(StopUserImportJobRequest stopUserImportJobRequest)
Stops the user import job.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Assigns a set of tags to an Amazon Cognito user pool.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes the specified tags from an Amazon Cognito user pool.
|
UpdateAuthEventFeedbackResult |
updateAuthEventFeedback(UpdateAuthEventFeedbackRequest updateAuthEventFeedbackRequest)
Provides the feedback for an authentication event whether it was from a
valid user or not.
|
UpdateDeviceStatusResult |
updateDeviceStatus(UpdateDeviceStatusRequest updateDeviceStatusRequest)
Updates the device status.
|
UpdateGroupResult |
updateGroup(UpdateGroupRequest updateGroupRequest)
Updates the specified group with the specified attributes.
|
UpdateIdentityProviderResult |
updateIdentityProvider(UpdateIdentityProviderRequest updateIdentityProviderRequest)
Updates identity provider information for a user pool.
|
UpdateResourceServerResult |
updateResourceServer(UpdateResourceServerRequest updateResourceServerRequest)
Updates the name and scopes of resource server.
|
UpdateUserAttributesResult |
updateUserAttributes(UpdateUserAttributesRequest updateUserAttributesRequest)
Allows a user to update a specific attribute (one at a time).
|
UpdateUserPoolResult |
updateUserPool(UpdateUserPoolRequest updateUserPoolRequest)
Updates the specified user pool with the specified attributes.
|
UpdateUserPoolClientResult |
updateUserPoolClient(UpdateUserPoolClientRequest updateUserPoolClientRequest)
Updates the specified user pool app client with the specified attributes.
|
UpdateUserPoolDomainResult |
updateUserPoolDomain(UpdateUserPoolDomainRequest updateUserPoolDomainRequest)
Updates the Secure Sockets Layer (SSL) certificate for the custom domain
for your user pool.
|
VerifySoftwareTokenResult |
verifySoftwareToken(VerifySoftwareTokenRequest verifySoftwareTokenRequest)
Use this API to register a user's entered TOTP code and mark the user's
software token MFA status as "verified" if successful.
|
VerifyUserAttributeResult |
verifyUserAttribute(VerifyUserAttributeRequest verifyUserAttributeRequest)
Verifies the specified user attributes in the user pool.
|
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 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(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(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(AWSCredentials awsCredentials, 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(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(AWSCredentialsProvider awsCredentialsProvider, 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(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, 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(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, 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 AmazonServiceException, AmazonClientException
Adds additional user attributes to the user pool schema.
addCustomAttributes in interface AmazonCognitoIdentityProvideraddCustomAttributesRequest - Represents the request to add custom attributes.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserImportInProgressExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public void adminAddUserToGroup(AdminAddUserToGroupRequest adminAddUserToGroupRequest) throws AmazonServiceException, AmazonClientException
Adds the specified user to the specified group.
Calling this action requires developer credentials.
adminAddUserToGroup in interface AmazonCognitoIdentityProvideradminAddUserToGroupRequest - InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminConfirmSignUpResult adminConfirmSignUp(AdminConfirmSignUpRequest adminConfirmSignUpRequest) throws AmazonServiceException, AmazonClientException
Confirms user registration as an admin without using a confirmation code. Works on any user.
Calling this action requires developer credentials.
adminConfirmSignUp in interface AmazonCognitoIdentityProvideradminConfirmSignUpRequest - Represents the request to confirm user registration.
ResourceNotFoundExceptionInvalidParameterExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionNotAuthorizedExceptionTooManyFailedAttemptsExceptionInvalidLambdaResponseExceptionTooManyRequestsExceptionLimitExceededExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminCreateUserResult adminCreateUser(AdminCreateUserRequest adminCreateUserRequest) throws AmazonServiceException, AmazonClientException
Creates a new user in the specified user pool.
If MessageAction is not set, the default is to send a
welcome message via email or phone (SMS).
This message is based on a template that you configured in your call to or . This template includes your custom sign-up instructions and placeholders for user name and temporary password.
Alternatively, you can call AdminCreateUser with “SUPPRESS” for the
MessageAction parameter, and Amazon Cognito will not send
any email.
In either case, the user will be in the
FORCE_CHANGE_PASSWORD state until they sign in and change
their password.
AdminCreateUser requires developer credentials.
adminCreateUser in interface AmazonCognitoIdentityProvideradminCreateUserRequest - Represents the request to create a user in the specified user pool.
ResourceNotFoundExceptionInvalidParameterExceptionUserNotFoundExceptionUsernameExistsExceptionInvalidPasswordExceptionCodeDeliveryFailureExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionInvalidLambdaResponseExceptionPreconditionNotMetExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionTooManyRequestsExceptionNotAuthorizedExceptionUnsupportedUserStateExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public void adminDeleteUser(AdminDeleteUserRequest adminDeleteUserRequest) throws AmazonServiceException, AmazonClientException
Deletes a user as an administrator. Works on any user.
Calling this action requires developer credentials.
adminDeleteUser in interface AmazonCognitoIdentityProvideradminDeleteUserRequest - Represents the request to delete a user as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminDeleteUserAttributesResult adminDeleteUserAttributes(AdminDeleteUserAttributesRequest adminDeleteUserAttributesRequest) throws AmazonServiceException, AmazonClientException
Deletes the user attributes in a user pool as an administrator. Works on any user.
Calling this action requires developer credentials.
adminDeleteUserAttributes in interface AmazonCognitoIdentityProvideradminDeleteUserAttributesRequest - Represents the request to delete user attributes as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminDisableProviderForUserResult adminDisableProviderForUser(AdminDisableProviderForUserRequest adminDisableProviderForUserRequest) throws AmazonServiceException, AmazonClientException
Disables the user from signing in with the specified external (SAML or
social) identity provider. If the user to disable is a Cognito User Pools
native username + password user, they are not permitted to use their
password to sign-in. If the user to disable is a linked external IdP
user, any link between that user and an existing user is removed. The
next time the external user (no longer attached to the previously linked
DestinationUser) signs in, they must create a new user
account. See .
This action is enabled only for admin access and requires developer credentials.
The ProviderName must match the value specified when
creating an IdP for the pool.
To disable a native username + password user, the
ProviderName value must be Cognito and the
ProviderAttributeName must be Cognito_Subject,
with the ProviderAttributeValue being the name that is used
in the user pool for the user.
The ProviderAttributeName must always be
Cognito_Subject for social identity providers. The
ProviderAttributeValue must always be the exact subject that
was used when the user was originally linked as a source user.
For de-linking a SAML identity, there are two scenarios. If the linked
identity has not yet been used to sign-in, the
ProviderAttributeName and
ProviderAttributeValue must be the same values that were
used for the SourceUser when the identities were originally
linked in the call. (If the linking was done with
ProviderAttributeName set to Cognito_Subject,
the same applies here). However, if the user has already signed in, the
ProviderAttributeName must be Cognito_Subject
and ProviderAttributeValue must be the subject of the SAML
assertion.
adminDisableProviderForUser in interface AmazonCognitoIdentityProvideradminDisableProviderForUserRequest - ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionAliasExistsExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminDisableUserResult adminDisableUser(AdminDisableUserRequest adminDisableUserRequest) throws AmazonServiceException, AmazonClientException
Disables the specified user.
Calling this action requires developer credentials.
adminDisableUser in interface AmazonCognitoIdentityProvideradminDisableUserRequest - Represents the request to disable any user as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminEnableUserResult adminEnableUser(AdminEnableUserRequest adminEnableUserRequest) throws AmazonServiceException, AmazonClientException
Enables the specified user as an administrator. Works on any user.
Calling this action requires developer credentials.
adminEnableUser in interface AmazonCognitoIdentityProvideradminEnableUserRequest - Represents the request that enables the user as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public void adminForgetDevice(AdminForgetDeviceRequest adminForgetDeviceRequest) throws AmazonServiceException, AmazonClientException
Forgets the device, as an administrator.
Calling this action requires developer credentials.
adminForgetDevice in interface AmazonCognitoIdentityProvideradminForgetDeviceRequest - Sends the forgot device request, as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionInvalidUserPoolConfigurationExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminGetDeviceResult adminGetDevice(AdminGetDeviceRequest adminGetDeviceRequest) throws AmazonServiceException, AmazonClientException
Gets the device, as an administrator.
Calling this action requires developer credentials.
adminGetDevice in interface AmazonCognitoIdentityProvideradminGetDeviceRequest - Represents the request to get the device, as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionInvalidUserPoolConfigurationExceptionTooManyRequestsExceptionInternalErrorExceptionNotAuthorizedExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminGetUserResult adminGetUser(AdminGetUserRequest adminGetUserRequest) throws AmazonServiceException, AmazonClientException
Gets the specified user by user name in a user pool as an administrator. Works on any user.
Calling this action requires developer credentials.
adminGetUser in interface AmazonCognitoIdentityProvideradminGetUserRequest - Represents the request to get the specified user as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminInitiateAuthResult adminInitiateAuth(AdminInitiateAuthRequest adminInitiateAuthRequest) throws AmazonServiceException, AmazonClientException
Initiates the authentication flow, as an administrator.
Calling this action requires developer credentials.
adminInitiateAuth in interface AmazonCognitoIdentityProvideradminInitiateAuthRequest - Initiates the authorization request, as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptionUnexpectedLambdaExceptionInvalidUserPoolConfigurationExceptionUserLambdaValidationExceptionInvalidLambdaResponseExceptionMFAMethodNotFoundExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminLinkProviderForUserResult adminLinkProviderForUser(AdminLinkProviderForUserRequest adminLinkProviderForUserRequest) throws AmazonServiceException, AmazonClientException
Links an existing user account in a user pool (
DestinationUser) to an identity from an external identity
provider (SourceUser) based on a specified attribute name
and value from the external identity provider. This allows you to create
a link from the existing user account to an external federated user
identity that has not yet been used to sign in, so that the federated
user identity can be used to sign in as the existing user account.
For example, if there is an existing user with a username and password, this API links that user to a federated user identity, so that when the federated user identity is used, the user signs in as the existing user account.
Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external identity providers and provider attributes that have been trusted by the application owner.
See also .
This action is enabled only for admin access and requires developer credentials.
adminLinkProviderForUser in interface AmazonCognitoIdentityProvideradminLinkProviderForUserRequest - ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionAliasExistsExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminListDevicesResult adminListDevices(AdminListDevicesRequest adminListDevicesRequest) throws AmazonServiceException, AmazonClientException
Lists devices, as an administrator.
Calling this action requires developer credentials.
adminListDevices in interface AmazonCognitoIdentityProvideradminListDevicesRequest - Represents the request to list devices, as an administrator.
InvalidParameterExceptionResourceNotFoundExceptionInvalidUserPoolConfigurationExceptionTooManyRequestsExceptionInternalErrorExceptionNotAuthorizedExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminListGroupsForUserResult adminListGroupsForUser(AdminListGroupsForUserRequest adminListGroupsForUserRequest) throws AmazonServiceException, AmazonClientException
Lists the groups that the user belongs to.
Calling this action requires developer credentials.
adminListGroupsForUser in interface AmazonCognitoIdentityProvideradminListGroupsForUserRequest - InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminListUserAuthEventsResult adminListUserAuthEvents(AdminListUserAuthEventsRequest adminListUserAuthEventsRequest) throws AmazonServiceException, AmazonClientException
Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security.
adminListUserAuthEvents in interface AmazonCognitoIdentityProvideradminListUserAuthEventsRequest - InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionUserPoolAddOnNotEnabledExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public void adminRemoveUserFromGroup(AdminRemoveUserFromGroupRequest adminRemoveUserFromGroupRequest) throws AmazonServiceException, AmazonClientException
Removes the specified user from the specified group.
Calling this action requires developer credentials.
adminRemoveUserFromGroup in interface AmazonCognitoIdentityProvideradminRemoveUserFromGroupRequest - InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminResetUserPasswordResult adminResetUserPassword(AdminResetUserPasswordRequest adminResetUserPasswordRequest) throws AmazonServiceException, AmazonClientException
Resets the specified user's password in a user pool as an administrator. Works on any user.
When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password.
Calling this action requires developer credentials.
adminResetUserPassword in interface AmazonCognitoIdentityProvideradminResetUserPasswordRequest - Represents the request to reset a user's password as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionNotAuthorizedExceptionInvalidLambdaResponseExceptionTooManyRequestsExceptionLimitExceededExceptionUserNotFoundExceptionInvalidSmsRoleAccessPolicyExceptionInvalidEmailRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminRespondToAuthChallengeResult adminRespondToAuthChallenge(AdminRespondToAuthChallengeRequest adminRespondToAuthChallengeRequest) throws AmazonServiceException, AmazonClientException
Responds to an authentication challenge, as an administrator.
Calling this action requires developer credentials.
adminRespondToAuthChallenge in interface AmazonCognitoIdentityProvideradminRespondToAuthChallengeRequest - The request to respond to the authentication challenge, as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionCodeMismatchExceptionExpiredCodeExceptionUnexpectedLambdaExceptionInvalidPasswordExceptionUserLambdaValidationExceptionInvalidLambdaResponseExceptionTooManyRequestsExceptionInvalidUserPoolConfigurationExceptionInternalErrorExceptionMFAMethodNotFoundExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionAliasExistsExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionSoftwareTokenMFANotFoundExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminSetUserMFAPreferenceResult adminSetUserMFAPreference(AdminSetUserMFAPreferenceRequest adminSetUserMFAPreferenceRequest) throws AmazonServiceException, AmazonClientException
Sets the user's multi-factor authentication (MFA) preference, including which MFA options are enabled and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are enabled. If multiple options are enabled and no preference is set, a challenge to choose an MFA option will be returned during sign in.
adminSetUserMFAPreference in interface AmazonCognitoIdentityProvideradminSetUserMFAPreferenceRequest - ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminSetUserPasswordResult adminSetUserPassword(AdminSetUserPasswordRequest adminSetUserPasswordRequest) throws AmazonServiceException, 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 will be placed into the FORCE_CHANGE_PASSWORD state.
When the user next tries to sign in, the InitiateAuth/AdminInitiateAuth
response will contain the NEW_PASSWORD_REQUIRED challenge.
If the user does not sign in before it expires, the user will not be able
to sign in and their password will need to be reset by an administrator.
Once the user has set a new password, or the password is permanent, the
user status will be set to Confirmed.
adminSetUserPassword in interface AmazonCognitoIdentityProvideradminSetUserPasswordRequest - ResourceNotFoundExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptionTooManyRequestsExceptionInvalidParameterExceptionInvalidPasswordExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminSetUserSettingsResult adminSetUserSettings(AdminSetUserSettingsRequest adminSetUserSettingsRequest) throws AmazonServiceException, AmazonClientException
This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either type of MFA, use the AdminSetUserMFAPreference action instead.
adminSetUserSettings in interface AmazonCognitoIdentityProvideradminSetUserSettingsRequest - You can use this parameter to set an MFA configuration that uses the SMS delivery medium.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminUpdateAuthEventFeedbackResult adminUpdateAuthEventFeedback(AdminUpdateAuthEventFeedbackRequest adminUpdateAuthEventFeedbackRequest) throws AmazonServiceException, AmazonClientException
Provides feedback for an authentication event as to whether it was from a valid user. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.
adminUpdateAuthEventFeedback in interface AmazonCognitoIdentityProvideradminUpdateAuthEventFeedbackRequest - InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionUserPoolAddOnNotEnabledExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminUpdateDeviceStatusResult adminUpdateDeviceStatus(AdminUpdateDeviceStatusRequest adminUpdateDeviceStatusRequest) throws AmazonServiceException, AmazonClientException
Updates the device status as an administrator.
Calling this action requires developer credentials.
adminUpdateDeviceStatus in interface AmazonCognitoIdentityProvideradminUpdateDeviceStatusRequest - The request to update the device status, as an administrator.
InvalidParameterExceptionResourceNotFoundExceptionInvalidUserPoolConfigurationExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminUpdateUserAttributesResult adminUpdateUserAttributes(AdminUpdateUserAttributesRequest adminUpdateUserAttributesRequest) throws AmazonServiceException, AmazonClientException
Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.
For custom attributes, you must prepend the custom: prefix
to the attribute name.
In addition to updating user attributes, this API can also be used to mark phone and email as verified.
Calling this action requires developer credentials.
adminUpdateUserAttributes in interface AmazonCognitoIdentityProvideradminUpdateUserAttributesRequest - Represents the request to update the user's attributes as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionInvalidLambdaResponseExceptionAliasExistsExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptionInvalidSmsRoleAccessPolicyExceptionInvalidEmailRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminUserGlobalSignOutResult adminUserGlobalSignOut(AdminUserGlobalSignOutRequest adminUserGlobalSignOutRequest) throws AmazonServiceException, AmazonClientException
Signs out users from all devices, as an administrator. It also invalidates all refresh tokens issued to a user. The user's current access and Id tokens remain valid until their expiry. Access and Id tokens expire one hour after they are issued.
Calling this action requires developer credentials.
adminUserGlobalSignOut in interface AmazonCognitoIdentityProvideradminUserGlobalSignOutRequest - The request to sign out of all devices, as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AssociateSoftwareTokenResult associateSoftwareToken(AssociateSoftwareTokenRequest associateSoftwareTokenRequest) throws AmazonServiceException, AmazonClientException
Returns a unique generated shared secret key code for the user account. The request takes an access token or a session string, but not both.
associateSoftwareToken in interface AmazonCognitoIdentityProviderassociateSoftwareTokenRequest - InvalidParameterExceptionNotAuthorizedExceptionResourceNotFoundExceptionInternalErrorExceptionSoftwareTokenMFANotFoundExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ChangePasswordResult changePassword(ChangePasswordRequest changePasswordRequest) throws AmazonServiceException, AmazonClientException
Changes the password for a specified user in a user pool.
changePassword in interface AmazonCognitoIdentityProviderchangePasswordRequest - Represents the request to change a user password.
ResourceNotFoundExceptionInvalidParameterExceptionInvalidPasswordExceptionNotAuthorizedExceptionTooManyRequestsExceptionLimitExceededExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ConfirmDeviceResult confirmDevice(ConfirmDeviceRequest confirmDeviceRequest) throws AmazonServiceException, AmazonClientException
Confirms tracking of the device. This API call is the call that begins device tracking.
confirmDevice in interface AmazonCognitoIdentityProviderconfirmDeviceRequest - Confirms the device request.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionInvalidPasswordExceptionInvalidLambdaResponseExceptionUsernameExistsExceptionInvalidUserPoolConfigurationExceptionTooManyRequestsExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ConfirmForgotPasswordResult confirmForgotPassword(ConfirmForgotPasswordRequest confirmForgotPasswordRequest) throws AmazonServiceException, AmazonClientException
Allows a user to enter a confirmation code to reset a forgotten password.
confirmForgotPassword in interface AmazonCognitoIdentityProviderconfirmForgotPasswordRequest - The request representing the confirmation for a password reset.
ResourceNotFoundExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionInvalidParameterExceptionInvalidPasswordExceptionNotAuthorizedExceptionCodeMismatchExceptionExpiredCodeExceptionTooManyFailedAttemptsExceptionInvalidLambdaResponseExceptionTooManyRequestsExceptionLimitExceededExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ConfirmSignUpResult confirmSignUp(ConfirmSignUpRequest confirmSignUpRequest) throws AmazonServiceException, AmazonClientException
Confirms registration of a user and handles the existing alias from a previous user.
confirmSignUp in interface AmazonCognitoIdentityProviderconfirmSignUpRequest - Represents the request to confirm registration of a user.
ResourceNotFoundExceptionInvalidParameterExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionNotAuthorizedExceptionTooManyFailedAttemptsExceptionCodeMismatchExceptionExpiredCodeExceptionInvalidLambdaResponseExceptionAliasExistsExceptionTooManyRequestsExceptionLimitExceededExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public CreateGroupResult createGroup(CreateGroupRequest createGroupRequest) throws AmazonServiceException, AmazonClientException
Creates a new group in the specified user pool.
Calling this action requires developer credentials.
createGroup in interface AmazonCognitoIdentityProvidercreateGroupRequest - InvalidParameterExceptionGroupExistsExceptionResourceNotFoundExceptionTooManyRequestsExceptionLimitExceededExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public CreateIdentityProviderResult createIdentityProvider(CreateIdentityProviderRequest createIdentityProviderRequest) throws AmazonServiceException, AmazonClientException
Creates an identity provider for a user pool.
createIdentityProvider in interface AmazonCognitoIdentityProvidercreateIdentityProviderRequest - InvalidParameterExceptionDuplicateProviderExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionLimitExceededExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public CreateResourceServerResult createResourceServer(CreateResourceServerRequest createResourceServerRequest) throws AmazonServiceException, AmazonClientException
Creates a new OAuth2.0 resource server and defines custom scopes in it.
createResourceServer in interface AmazonCognitoIdentityProvidercreateResourceServerRequest - InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionLimitExceededExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public CreateUserImportJobResult createUserImportJob(CreateUserImportJobRequest createUserImportJobRequest) throws AmazonServiceException, AmazonClientException
Creates the user import job.
createUserImportJob in interface AmazonCognitoIdentityProvidercreateUserImportJobRequest - Represents the request to create the user import job.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionPreconditionNotMetExceptionNotAuthorizedExceptionLimitExceededExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public CreateUserPoolResult createUserPool(CreateUserPoolRequest createUserPoolRequest) throws AmazonServiceException, AmazonClientException
Creates a new Amazon Cognito user pool and sets the password policy for the pool.
createUserPool in interface AmazonCognitoIdentityProvidercreateUserPoolRequest - Represents the request to create a user pool.
InvalidParameterExceptionTooManyRequestsExceptionLimitExceededExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionInvalidEmailRoleAccessPolicyExceptionNotAuthorizedExceptionUserPoolTaggingExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public CreateUserPoolClientResult createUserPoolClient(CreateUserPoolClientRequest createUserPoolClientRequest) throws AmazonServiceException, AmazonClientException
Creates the user pool client.
createUserPoolClient in interface AmazonCognitoIdentityProvidercreateUserPoolClientRequest - Represents the request to create a user pool client.
InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionLimitExceededExceptionNotAuthorizedExceptionScopeDoesNotExistExceptionInvalidOAuthFlowExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public CreateUserPoolDomainResult createUserPoolDomain(CreateUserPoolDomainRequest createUserPoolDomainRequest) throws AmazonServiceException, AmazonClientException
Creates a new domain for a user pool.
createUserPoolDomain in interface AmazonCognitoIdentityProvidercreateUserPoolDomainRequest - InvalidParameterExceptionNotAuthorizedExceptionResourceNotFoundExceptionLimitExceededExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public void deleteGroup(DeleteGroupRequest deleteGroupRequest) throws AmazonServiceException, AmazonClientException
Deletes a group. Currently only groups with no members can be deleted.
Calling this action requires developer credentials.
deleteGroup in interface AmazonCognitoIdentityProviderdeleteGroupRequest - ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public void deleteIdentityProvider(DeleteIdentityProviderRequest deleteIdentityProviderRequest) throws AmazonServiceException, AmazonClientException
Deletes an identity provider for a user pool.
deleteIdentityProvider in interface AmazonCognitoIdentityProviderdeleteIdentityProviderRequest - InvalidParameterExceptionUnsupportedIdentityProviderExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public void deleteResourceServer(DeleteResourceServerRequest deleteResourceServerRequest) throws AmazonServiceException, AmazonClientException
Deletes a resource server.
deleteResourceServer in interface AmazonCognitoIdentityProviderdeleteResourceServerRequest - InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public void deleteUser(DeleteUserRequest deleteUserRequest) throws AmazonServiceException, AmazonClientException
Allows a user to delete himself or herself.
deleteUser in interface AmazonCognitoIdentityProviderdeleteUserRequest - Represents the request to delete a user.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionTooManyRequestsExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public DeleteUserAttributesResult deleteUserAttributes(DeleteUserAttributesRequest deleteUserAttributesRequest) throws AmazonServiceException, AmazonClientException
Deletes the attributes for a user.
deleteUserAttributes in interface AmazonCognitoIdentityProviderdeleteUserAttributesRequest - Represents the request to delete user attributes.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionTooManyRequestsExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public void deleteUserPool(DeleteUserPoolRequest deleteUserPoolRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified Amazon Cognito user pool.
deleteUserPool in interface AmazonCognitoIdentityProviderdeleteUserPoolRequest - Represents the request to delete a user pool.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserImportInProgressExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public void deleteUserPoolClient(DeleteUserPoolClientRequest deleteUserPoolClientRequest) throws AmazonServiceException, AmazonClientException
Allows the developer to delete the user pool client.
deleteUserPoolClient in interface AmazonCognitoIdentityProviderdeleteUserPoolClientRequest - Represents the request to delete a user pool client.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public DeleteUserPoolDomainResult deleteUserPoolDomain(DeleteUserPoolDomainRequest deleteUserPoolDomainRequest) throws AmazonServiceException, AmazonClientException
Deletes a domain for a user pool.
deleteUserPoolDomain in interface AmazonCognitoIdentityProviderdeleteUserPoolDomainRequest - NotAuthorizedExceptionInvalidParameterExceptionResourceNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public DescribeIdentityProviderResult describeIdentityProvider(DescribeIdentityProviderRequest describeIdentityProviderRequest) throws AmazonServiceException, AmazonClientException
Gets information about a specific identity provider.
describeIdentityProvider in interface AmazonCognitoIdentityProviderdescribeIdentityProviderRequest - InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public DescribeResourceServerResult describeResourceServer(DescribeResourceServerRequest describeResourceServerRequest) throws AmazonServiceException, AmazonClientException
Describes a resource server.
describeResourceServer in interface AmazonCognitoIdentityProviderdescribeResourceServerRequest - InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public DescribeRiskConfigurationResult describeRiskConfiguration(DescribeRiskConfigurationRequest describeRiskConfigurationRequest) throws AmazonServiceException, AmazonClientException
Describes the risk configuration.
describeRiskConfiguration in interface AmazonCognitoIdentityProviderdescribeRiskConfigurationRequest - ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserPoolAddOnNotEnabledExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public DescribeUserImportJobResult describeUserImportJob(DescribeUserImportJobRequest describeUserImportJobRequest) throws AmazonServiceException, AmazonClientException
Describes the user import job.
describeUserImportJob in interface AmazonCognitoIdentityProviderdescribeUserImportJobRequest - Represents the request to describe the user import job.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public DescribeUserPoolResult describeUserPool(DescribeUserPoolRequest describeUserPoolRequest) throws AmazonServiceException, AmazonClientException
Returns the configuration information and metadata of the specified user pool.
describeUserPool in interface AmazonCognitoIdentityProviderdescribeUserPoolRequest - Represents the request to describe the user pool.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserPoolTaggingExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public DescribeUserPoolClientResult describeUserPoolClient(DescribeUserPoolClientRequest describeUserPoolClientRequest) throws AmazonServiceException, AmazonClientException
Client method for returning the configuration information and metadata of the specified user pool app client.
describeUserPoolClient in interface AmazonCognitoIdentityProviderdescribeUserPoolClientRequest - Represents the request to describe a user pool client.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public DescribeUserPoolDomainResult describeUserPoolDomain(DescribeUserPoolDomainRequest describeUserPoolDomainRequest) throws AmazonServiceException, AmazonClientException
Gets information about a domain.
describeUserPoolDomain in interface AmazonCognitoIdentityProviderdescribeUserPoolDomainRequest - NotAuthorizedExceptionInvalidParameterExceptionResourceNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public void forgetDevice(ForgetDeviceRequest forgetDeviceRequest) throws AmazonServiceException, AmazonClientException
Forgets the specified device.
forgetDevice in interface AmazonCognitoIdentityProviderforgetDeviceRequest - Represents the request to forget the device.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionTooManyRequestsExceptionInvalidUserPoolConfigurationExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ForgotPasswordResult forgotPassword(ForgotPasswordRequest forgotPasswordRequest) throws AmazonServiceException, 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. If neither a verified phone number nor a verified email
exists, an InvalidParameterException is thrown. To use the
confirmation code for resetting the password, call .
forgotPassword in interface AmazonCognitoIdentityProviderforgotPasswordRequest - Represents the request to reset a user's password.
ResourceNotFoundExceptionInvalidParameterExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionNotAuthorizedExceptionInvalidLambdaResponseExceptionTooManyRequestsExceptionLimitExceededExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionInvalidEmailRoleAccessPolicyExceptionCodeDeliveryFailureExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public GetCSVHeaderResult getCSVHeader(GetCSVHeaderRequest getCSVHeaderRequest) throws AmazonServiceException, AmazonClientException
Gets the header information for the .csv file to be used as input for the user import job.
getCSVHeader in interface AmazonCognitoIdentityProvidergetCSVHeaderRequest - Represents the request to get the header information for the .csv file for the user import job.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public GetDeviceResult getDevice(GetDeviceRequest getDeviceRequest) throws AmazonServiceException, AmazonClientException
Gets the device.
getDevice in interface AmazonCognitoIdentityProvidergetDeviceRequest - Represents the request to get the device.
ResourceNotFoundExceptionInvalidParameterExceptionInvalidUserPoolConfigurationExceptionNotAuthorizedExceptionTooManyRequestsExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public GetGroupResult getGroup(GetGroupRequest getGroupRequest) throws AmazonServiceException, AmazonClientException
Gets a group.
Calling this action requires developer credentials.
getGroup in interface AmazonCognitoIdentityProvidergetGroupRequest - ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public GetIdentityProviderByIdentifierResult getIdentityProviderByIdentifier(GetIdentityProviderByIdentifierRequest getIdentityProviderByIdentifierRequest) throws AmazonServiceException, AmazonClientException
Gets the specified identity provider.
getIdentityProviderByIdentifier in interface AmazonCognitoIdentityProvidergetIdentityProviderByIdentifierRequest - InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public GetSigningCertificateResult getSigningCertificate(GetSigningCertificateRequest getSigningCertificateRequest) throws AmazonServiceException, AmazonClientException
This method takes a user pool ID, and returns the signing certificate.
getSigningCertificate in interface AmazonCognitoIdentityProvidergetSigningCertificateRequest - Request to get a signing certificate from Cognito.
InternalErrorExceptionInvalidParameterExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public GetUICustomizationResult getUICustomization(GetUICustomizationRequest getUICustomizationRequest) throws AmazonServiceException, AmazonClientException
Gets the UI Customization information for a particular app client's app
UI, if there is something set. If nothing is set for the particular
client, but there is an existing pool level customization (app
clientId will be ALL), then that is returned.
If nothing is present, then an empty shape is returned.
getUICustomization in interface AmazonCognitoIdentityProvidergetUICustomizationRequest - InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public GetUserResult getUser(GetUserRequest getUserRequest) throws AmazonServiceException, AmazonClientException
Gets the user attributes and metadata for a user.
getUser in interface AmazonCognitoIdentityProvidergetUserRequest - Represents the request to get information about the user.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionTooManyRequestsExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public GetUserAttributeVerificationCodeResult getUserAttributeVerificationCode(GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest) throws AmazonServiceException, AmazonClientException
Gets the user attribute verification code for the specified attribute name.
getUserAttributeVerificationCode in interface AmazonCognitoIdentityProvidergetUserAttributeVerificationCodeRequest - Represents the request to get user attribute verification.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionInvalidLambdaResponseExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionInvalidEmailRoleAccessPolicyExceptionCodeDeliveryFailureExceptionLimitExceededExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public GetUserPoolMfaConfigResult getUserPoolMfaConfig(GetUserPoolMfaConfigRequest getUserPoolMfaConfigRequest) throws AmazonServiceException, AmazonClientException
Gets the user pool multi-factor authentication (MFA) configuration.
getUserPoolMfaConfig in interface AmazonCognitoIdentityProvidergetUserPoolMfaConfigRequest - InvalidParameterExceptionTooManyRequestsExceptionResourceNotFoundExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public GlobalSignOutResult globalSignOut(GlobalSignOutRequest globalSignOutRequest) throws AmazonServiceException, AmazonClientException
Signs out users from all devices. It also invalidates all refresh tokens issued to a user. The user's current access and Id tokens remain valid until their expiry. Access and Id tokens expire one hour after they are issued.
globalSignOut in interface AmazonCognitoIdentityProviderglobalSignOutRequest - Represents the request to sign out all devices.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionTooManyRequestsExceptionPasswordResetRequiredExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public InitiateAuthResult initiateAuth(InitiateAuthRequest initiateAuthRequest) throws AmazonServiceException, AmazonClientException
Initiates the authentication flow.
initiateAuth in interface AmazonCognitoIdentityProviderinitiateAuthRequest - Initiates the authentication request.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionTooManyRequestsExceptionUnexpectedLambdaExceptionInvalidUserPoolConfigurationExceptionUserLambdaValidationExceptionInvalidLambdaResponseExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ListDevicesResult listDevices(ListDevicesRequest listDevicesRequest) throws AmazonServiceException, AmazonClientException
Lists the devices.
listDevices in interface AmazonCognitoIdentityProviderlistDevicesRequest - Represents the request to list the devices.
InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionInvalidUserPoolConfigurationExceptionTooManyRequestsExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ListGroupsResult listGroups(ListGroupsRequest listGroupsRequest) throws AmazonServiceException, AmazonClientException
Lists the groups associated with a user pool.
Calling this action requires developer credentials.
listGroups in interface AmazonCognitoIdentityProviderlistGroupsRequest - InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ListIdentityProvidersResult listIdentityProviders(ListIdentityProvidersRequest listIdentityProvidersRequest) throws AmazonServiceException, AmazonClientException
Lists information about all identity providers for a user pool.
listIdentityProviders in interface AmazonCognitoIdentityProviderlistIdentityProvidersRequest - InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ListResourceServersResult listResourceServers(ListResourceServersRequest listResourceServersRequest) throws AmazonServiceException, AmazonClientException
Lists the resource servers for a user pool.
listResourceServers in interface AmazonCognitoIdentityProviderlistResourceServersRequest - InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws AmazonServiceException, 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 - ResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInvalidParameterExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ListUserImportJobsResult listUserImportJobs(ListUserImportJobsRequest listUserImportJobsRequest) throws AmazonServiceException, AmazonClientException
Lists the user import jobs.
listUserImportJobs in interface AmazonCognitoIdentityProviderlistUserImportJobsRequest - Represents the request to list the user import jobs.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ListUserPoolClientsResult listUserPoolClients(ListUserPoolClientsRequest listUserPoolClientsRequest) throws AmazonServiceException, AmazonClientException
Lists the clients that have been created for the specified user pool.
listUserPoolClients in interface AmazonCognitoIdentityProviderlistUserPoolClientsRequest - Represents the request to list the user pool clients.
InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ListUserPoolsResult listUserPools(ListUserPoolsRequest listUserPoolsRequest) throws AmazonServiceException, AmazonClientException
Lists the user pools associated with an AWS account.
listUserPools in interface AmazonCognitoIdentityProviderlistUserPoolsRequest - Represents the request to list user pools.
InvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ListUsersResult listUsers(ListUsersRequest listUsersRequest) throws AmazonServiceException, AmazonClientException
Lists the users in the Amazon Cognito user pool.
listUsers in interface AmazonCognitoIdentityProviderlistUsersRequest - Represents the request to list users.
InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ListUsersInGroupResult listUsersInGroup(ListUsersInGroupRequest listUsersInGroupRequest) throws AmazonServiceException, AmazonClientException
Lists the users in the specified group.
Calling this action requires developer credentials.
listUsersInGroup in interface AmazonCognitoIdentityProviderlistUsersInGroupRequest - InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ResendConfirmationCodeResult resendConfirmationCode(ResendConfirmationCodeRequest resendConfirmationCodeRequest) throws AmazonServiceException, AmazonClientException
Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
resendConfirmationCode in interface AmazonCognitoIdentityProviderresendConfirmationCodeRequest - Represents the request to resend the confirmation code.
ResourceNotFoundExceptionInvalidParameterExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionNotAuthorizedExceptionInvalidLambdaResponseExceptionTooManyRequestsExceptionLimitExceededExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionInvalidEmailRoleAccessPolicyExceptionCodeDeliveryFailureExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public RespondToAuthChallengeResult respondToAuthChallenge(RespondToAuthChallengeRequest respondToAuthChallengeRequest) throws AmazonServiceException, AmazonClientException
Responds to the authentication challenge.
respondToAuthChallenge in interface AmazonCognitoIdentityProviderrespondToAuthChallengeRequest - The request to respond to an authentication challenge.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionCodeMismatchExceptionExpiredCodeExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionInvalidPasswordExceptionInvalidLambdaResponseExceptionTooManyRequestsExceptionInvalidUserPoolConfigurationExceptionMFAMethodNotFoundExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionAliasExistsExceptionInternalErrorExceptionSoftwareTokenMFANotFoundExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public SetRiskConfigurationResult setRiskConfiguration(SetRiskConfigurationRequest setRiskConfigurationRequest) throws AmazonServiceException, AmazonClientException
Configures actions on detected risks. To delete the risk configuration
for UserPoolId or ClientId, pass null values
for all four configuration types.
To enable Amazon Cognito advanced security features, update the user pool
to include the UserPoolAddOns key
AdvancedSecurityMode.
See .
setRiskConfiguration in interface AmazonCognitoIdentityProvidersetRiskConfigurationRequest - ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserPoolAddOnNotEnabledExceptionCodeDeliveryFailureExceptionInvalidEmailRoleAccessPolicyExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public SetUICustomizationResult setUICustomization(SetUICustomizationRequest setUICustomizationRequest) throws AmazonServiceException, AmazonClientException
Sets the UI customization information for a user pool's built-in app UI.
You can specify app UI customization settings for a single client (with a
specific clientId) or for all clients (by setting the
clientId to ALL). If you specify
ALL, the default configuration will be used for every client
that has no UI customization set previously. If you specify UI
customization settings for a particular client, it will no longer fall
back to the ALL configuration.
To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app's pages, and the service will throw an error.
setUICustomization in interface AmazonCognitoIdentityProvidersetUICustomizationRequest - InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public SetUserMFAPreferenceResult setUserMFAPreference(SetUserMFAPreferenceRequest setUserMFAPreferenceRequest) throws AmazonServiceException, AmazonClientException
Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are enabled and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are enabled. If multiple options are enabled and no preference is set, a challenge to choose an MFA option will be returned during sign in.
setUserMFAPreference in interface AmazonCognitoIdentityProvidersetUserMFAPreferenceRequest - ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public SetUserPoolMfaConfigResult setUserPoolMfaConfig(SetUserPoolMfaConfigRequest setUserPoolMfaConfigRequest) throws AmazonServiceException, AmazonClientException
Set the user pool multi-factor authentication (MFA) configuration.
setUserPoolMfaConfig in interface AmazonCognitoIdentityProvidersetUserPoolMfaConfigRequest - InvalidParameterExceptionTooManyRequestsExceptionResourceNotFoundExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public SetUserSettingsResult setUserSettings(SetUserSettingsRequest setUserSettingsRequest) throws AmazonServiceException, AmazonClientException
This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either type of MFA, use the SetUserMFAPreference action instead.
setUserSettings in interface AmazonCognitoIdentityProvidersetUserSettingsRequest - Represents the request to set user settings.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public SignUpResult signUp(SignUpRequest signUpRequest) throws AmazonServiceException, AmazonClientException
Registers the user in the specified user pool and creates a user name, password, and user attributes.
signUp in interface AmazonCognitoIdentityProvidersignUpRequest - Represents the request to register a user.
ResourceNotFoundExceptionInvalidParameterExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionNotAuthorizedExceptionInvalidPasswordExceptionInvalidLambdaResponseExceptionUsernameExistsExceptionTooManyRequestsExceptionInternalErrorExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionInvalidEmailRoleAccessPolicyExceptionCodeDeliveryFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public StartUserImportJobResult startUserImportJob(StartUserImportJobRequest startUserImportJobRequest) throws AmazonServiceException, AmazonClientException
Starts the user import.
startUserImportJob in interface AmazonCognitoIdentityProviderstartUserImportJobRequest - Represents the request to start the user import job.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionInternalErrorExceptionPreconditionNotMetExceptionNotAuthorizedExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public StopUserImportJobResult stopUserImportJob(StopUserImportJobRequest stopUserImportJobRequest) throws AmazonServiceException, AmazonClientException
Stops the user import job.
stopUserImportJob in interface AmazonCognitoIdentityProviderstopUserImportJobRequest - Represents the request to stop the user import job.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionInternalErrorExceptionPreconditionNotMetExceptionNotAuthorizedExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public TagResourceResult tagResource(TagResourceRequest tagResourceRequest) throws AmazonServiceException, 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 IAM policy, you can constrain permissions for user pools based on specific tags or tag values.
You can use this action up to 5 times per second, per account. A user pool can have as many as 50 tags.
tagResource in interface AmazonCognitoIdentityProvidertagResourceRequest - ResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInvalidParameterExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest) throws AmazonServiceException, 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 - ResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInvalidParameterExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public UpdateAuthEventFeedbackResult updateAuthEventFeedback(UpdateAuthEventFeedbackRequest updateAuthEventFeedbackRequest) throws AmazonServiceException, 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.
updateAuthEventFeedback in interface AmazonCognitoIdentityProviderupdateAuthEventFeedbackRequest - InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionUserPoolAddOnNotEnabledExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public UpdateDeviceStatusResult updateDeviceStatus(UpdateDeviceStatusRequest updateDeviceStatusRequest) throws AmazonServiceException, AmazonClientException
Updates the device status.
updateDeviceStatus in interface AmazonCognitoIdentityProviderupdateDeviceStatusRequest - Represents the request to update the device status.
InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionInvalidUserPoolConfigurationExceptionTooManyRequestsExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public UpdateGroupResult updateGroup(UpdateGroupRequest updateGroupRequest) throws AmazonServiceException, AmazonClientException
Updates the specified group with the specified attributes.
Calling this action requires developer credentials.
If you don't provide a value for an attribute, it will be set to the default value.
updateGroup in interface AmazonCognitoIdentityProviderupdateGroupRequest - ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public UpdateIdentityProviderResult updateIdentityProvider(UpdateIdentityProviderRequest updateIdentityProviderRequest) throws AmazonServiceException, AmazonClientException
Updates identity provider information for a user pool.
updateIdentityProvider in interface AmazonCognitoIdentityProviderupdateIdentityProviderRequest - InvalidParameterExceptionUnsupportedIdentityProviderExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public UpdateResourceServerResult updateResourceServer(UpdateResourceServerRequest updateResourceServerRequest) throws AmazonServiceException, 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 will be set to the default value.
updateResourceServer in interface AmazonCognitoIdentityProviderupdateResourceServerRequest - InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public UpdateUserAttributesResult updateUserAttributes(UpdateUserAttributesRequest updateUserAttributesRequest) throws AmazonServiceException, AmazonClientException
Allows a user to update a specific attribute (one at a time).
updateUserAttributes in interface AmazonCognitoIdentityProviderupdateUserAttributesRequest - Represents the request to update user attributes.
ResourceNotFoundExceptionInvalidParameterExceptionCodeMismatchExceptionExpiredCodeExceptionNotAuthorizedExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionInvalidLambdaResponseExceptionTooManyRequestsExceptionAliasExistsExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionInvalidEmailRoleAccessPolicyExceptionCodeDeliveryFailureExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public UpdateUserPoolResult updateUserPool(UpdateUserPoolRequest updateUserPoolRequest) throws AmazonServiceException, AmazonClientException
Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings with .
If you don't provide a value for an attribute, it will be set to the default value.
updateUserPool in interface AmazonCognitoIdentityProviderupdateUserPoolRequest - Represents the request to update the user pool.
ResourceNotFoundExceptionInvalidParameterExceptionConcurrentModificationExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserImportInProgressExceptionInternalErrorExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionUserPoolTaggingExceptionInvalidEmailRoleAccessPolicyExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public UpdateUserPoolClientResult updateUserPoolClient(UpdateUserPoolClientRequest updateUserPoolClientRequest) throws AmazonServiceException, 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 with .
If you don't provide a value for an attribute, it will be set to the default value.
updateUserPoolClient in interface AmazonCognitoIdentityProviderupdateUserPoolClientRequest - Represents the request to update the user pool client.
ResourceNotFoundExceptionInvalidParameterExceptionConcurrentModificationExceptionTooManyRequestsExceptionNotAuthorizedExceptionScopeDoesNotExistExceptionInvalidOAuthFlowExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public UpdateUserPoolDomainResult updateUserPoolDomain(UpdateUserPoolDomainRequest updateUserPoolDomainRequest) throws AmazonServiceException, 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 cannot use it to change the domain for a user pool.
A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and sign-in pages for your application. When you set up a custom domain, you provide a certificate that you manage with AWS Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain.
Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same, and your custom domain uses the new certificate automatically.
However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide this ARN to Amazon Cognito.
When you add your new certificate in ACM, you must choose US East (N. Virginia) as the AWS Region.
After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain.
For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
updateUserPoolDomain in interface AmazonCognitoIdentityProviderupdateUserPoolDomainRequest - The UpdateUserPoolDomain request input.
InvalidParameterExceptionNotAuthorizedExceptionResourceNotFoundExceptionTooManyRequestsExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public VerifySoftwareTokenResult verifySoftwareToken(VerifySoftwareTokenRequest verifySoftwareTokenRequest) throws AmazonServiceException, AmazonClientException
Use this API to register a user's entered TOTP code and mark the user's software token MFA status as "verified" if successful. The request takes an access token or a session string, but not both.
verifySoftwareToken in interface AmazonCognitoIdentityProviderverifySoftwareTokenRequest - InvalidParameterExceptionResourceNotFoundExceptionInvalidUserPoolConfigurationExceptionNotAuthorizedExceptionTooManyRequestsExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionEnableSoftwareTokenMFAExceptionNotAuthorizedExceptionSoftwareTokenMFANotFoundExceptionCodeMismatchExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public VerifyUserAttributeResult verifyUserAttribute(VerifyUserAttributeRequest verifyUserAttributeRequest) throws AmazonServiceException, AmazonClientException
Verifies the specified user attributes in the user pool.
verifyUserAttribute in interface AmazonCognitoIdentityProviderverifyUserAttributeRequest - Represents the request to verify user attributes.
ResourceNotFoundExceptionInvalidParameterExceptionCodeMismatchExceptionExpiredCodeExceptionNotAuthorizedExceptionTooManyRequestsExceptionLimitExceededExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.@Deprecated public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata in interface AmazonCognitoIdentityProviderrequest - The originally executed requestCopyright © 2020. All rights reserved.