com.amazonaws.services.cognitoidentityprovider

Interface AmazonCognitoIdentityProvider

All Known Implementing Classes:

AmazonCognitoIdentityProviderClient

public interface AmazonCognitoIdentityProvider

Interface for accessing Amazon Cognito Your User Pool

Using the Amazon Cognito Your 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 Your User Pools.

For more information, see the Amazon Cognito Documentation.

Method Summary

Modifier and Type	Method and Description
AddCustomAttributesResult	addCustomAttributes(AddCustomAttributesRequest addCustomAttributesRequest) Adds additional user attributes to the user pool schema.
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 and sends a welcome message via email or phone (SMS).
void	adminForgetDevice(AdminForgetDeviceRequest adminForgetDeviceRequest) Forgets the device, as an administrator.
AdminGetDeviceResult	adminGetDevice(AdminGetDeviceRequest adminGetDeviceRequest) Gets the device, as an administrator.
AdminInitiateAuthResult	adminInitiateAuth(AdminInitiateAuthRequest adminInitiateAuthRequest) Initiates the authentication flow, as an administrator.
AdminListDevicesResult	adminListDevices(AdminListDevicesRequest adminListDevicesRequest) Lists devices, as an administrator.
AdminRespondToAuthChallengeResult	adminRespondToAuthChallenge(AdminRespondToAuthChallengeRequest adminRespondToAuthChallengeRequest) Responds to an authentication challenge, as an administrator.
AdminSetUserSettingsResult	adminSetUserSettings(AdminSetUserSettingsRequest adminSetUserSettingsRequest) Sets all the user settings for a specified user name.
AdminUpdateDeviceStatusResult	adminUpdateDeviceStatus(AdminUpdateDeviceStatusRequest adminUpdateDeviceStatusRequest) Updates the device status as an administrator.
AdminUserGlobalSignOutResult	adminUserGlobalSignOut(AdminUserGlobalSignOutRequest adminUserGlobalSignOutRequest) Signs out users from all devices, as an administrator.
AssociateSoftwareTokenResult	associateSoftwareToken(AssociateSoftwareTokenRequest associateSoftwareTokenRequest)
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 code provided when they reset their password to update their password.
ConfirmSignUpResult	confirmSignUp(ConfirmSignUpRequest confirmSignUpRequest) Confirms registration of a user and handles the existing alias from a previous user.
CreateUserImportJobResult	createUserImportJob(CreateUserImportJobRequest createUserImportJobRequest) Creates the user import job.
CreateUserPoolClientResult	createUserPoolClient(CreateUserPoolClientRequest createUserPoolClientRequest) Creates the user pool client.
void	deleteUser(DeleteUserRequest deleteUserRequest) Allows a user to delete one's self.
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.
DescribeUserImportJobResult	describeUserImportJob(DescribeUserImportJobRequest describeUserImportJobRequest) Describes the user import job.
DescribeUserPoolClientResult	describeUserPoolClient(DescribeUserPoolClientRequest describeUserPoolClientRequest) Client method for returning the configuration information and metadata of the specified user pool client.
void	forgetDevice(ForgetDeviceRequest forgetDeviceRequest) Forgets the specified device.
ForgotPasswordResult	forgotPassword(ForgotPasswordRequest forgotPasswordRequest) Retrieves the password for the specified client ID or username.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetCSVHeaderResult	getCSVHeader(GetCSVHeaderRequest getCSVHeaderRequest) Gets the header information for the .csv file to be used as input for the user import job.
GetDeviceResult	getDevice(GetDeviceRequest getDeviceRequest) Gets the device.
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.
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.
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.
ListUsersResult	listUsers(ListUsersRequest listUsersRequest) Lists the users in the Amazon Cognito user pool.
ResendConfirmationCodeResult	resendConfirmationCode(ResendConfirmationCodeRequest resendConfirmationCodeRequest) Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
RespondToAuthChallengeResult	respondToAuthChallenge(RespondToAuthChallengeRequest respondToAuthChallengeRequest) Responds to the authentication challenge.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("https://cognito-idp.us-east-1.amazonaws.com").
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
SetUserMFAPreferenceResult	setUserMFAPreference(SetUserMFAPreferenceRequest setUserMFAPreferenceRequest)
SetUserSettingsResult	setUserSettings(SetUserSettingsRequest setUserSettingsRequest) Sets the user settings like multi-factor authentication (MFA).
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
SignUpResult	signUp(SignUpRequest signUpRequest) Registers the user in the specified user pool and creates a user name, password, and user attributes.
StartUserImportJobResult	startUserImportJob(StartUserImportJobRequest startUserImportJobRequest) Starts the user import.
StopUserImportJobResult	stopUserImportJob(StopUserImportJobRequest stopUserImportJobRequest) Stops the user import job.
UpdateDeviceStatusResult	updateDeviceStatus(UpdateDeviceStatusRequest updateDeviceStatusRequest) Updates the device status.
UpdateUserAttributesResult	updateUserAttributes(UpdateUserAttributesRequest updateUserAttributesRequest) Allows a user to update a specific attribute (one at a time).
UpdateUserPoolClientResult	updateUserPoolClient(UpdateUserPoolClientRequest updateUserPoolClientRequest) Allows the developer to update the specified user pool client and password policy.
VerifySoftwareTokenResult	verifySoftwareToken(VerifySoftwareTokenRequest verifySoftwareTokenRequest)
VerifyUserAttributeResult	verifyUserAttribute(VerifyUserAttributeRequest verifyUserAttributeRequest) Verifies the specified user attributes in the user pool.

Method Detail

setEndpoint

void setEndpoint(String endpoint)
          throws IllegalArgumentException

Overrides the default endpoint for this client ("https://cognito-idp.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "cognito-idp.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://cognito-idp.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "cognito-idp.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://cognito-idp.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

Throws:

IllegalArgumentException - If any problems are detected with the specified endpoint.

setRegion

void setRegion(Region region)
        throws IllegalArgumentException

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region.

Throws:

IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

addCustomAttributes

AddCustomAttributesResult addCustomAttributes(AddCustomAttributesRequest addCustomAttributesRequest)
                                       throws AmazonClientException,
                                              AmazonServiceException

Adds additional user attributes to the user pool schema.

Parameters:

addCustomAttributesRequest -

Represents the request to add custom attributes.

Returns:

addCustomAttributesResult The response from the AddCustomAttributes service method, as returned by Amazon Cognito Your User Pool.

Throws:

ResourceNotFoundException

InvalidParameterException

TooManyRequestsException

NotAuthorizedException

UserImportInProgressException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

adminConfirmSignUp

AdminConfirmSignUpResult adminConfirmSignUp(AdminConfirmSignUpRequest adminConfirmSignUpRequest)
                                     throws AmazonClientException,
                                            AmazonServiceException

Confirms user registration as an admin without using a confirmation code. Works on any user.

Parameters:

adminConfirmSignUpRequest -

Represents the request to confirm user registration.

Returns:

adminConfirmSignUpResult The response from the AdminConfirmSignUp service method, as returned by Amazon Cognito Your User Pool.

Throws:

ResourceNotFoundException

InvalidParameterException

UnexpectedLambdaException

UserLambdaValidationException

NotAuthorizedException

TooManyFailedAttemptsException

InvalidLambdaResponseException

TooManyRequestsException

LimitExceededException

UserNotFoundException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

adminCreateUser

AdminCreateUserResult adminCreateUser(AdminCreateUserRequest adminCreateUserRequest)
                               throws AmazonClientException,
                                      AmazonServiceException

Creates a new user in the specified user pool and sends a welcome message via email or phone (SMS). This message is based on a template that you configured in your call to CreateUserPool or UpdateUserPool. This template includes your custom sign-up instructions and placeholders for user name and temporary password.

Requires developer credentials.

Parameters:

adminCreateUserRequest -

Represents the request to create a user in the specified user pool.

Returns:

adminCreateUserResult The response from the AdminCreateUser service method, as returned by Amazon Cognito Your User Pool.

Throws:

ResourceNotFoundException

InvalidParameterException

UserNotFoundException

UsernameExistsException

InvalidPasswordException

CodeDeliveryFailureException

UnexpectedLambdaException

UserLambdaValidationException

InvalidLambdaResponseException

PreconditionNotMetException

InvalidSmsRoleAccessPolicyException

InvalidSmsRoleTrustRelationshipException

TooManyRequestsException

NotAuthorizedException

UnsupportedUserStateException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

adminForgetDevice

void adminForgetDevice(AdminForgetDeviceRequest adminForgetDeviceRequest)
                throws AmazonClientException,
                       AmazonServiceException

Forgets the device, as an administrator.

Parameters:

adminForgetDeviceRequest -

Sends the forgot device request, as an administrator.

Throws:

ResourceNotFoundException

InvalidParameterException

InvalidUserPoolConfigurationException

TooManyRequestsException

NotAuthorizedException

UserNotFoundException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

adminGetDevice

AdminGetDeviceResult adminGetDevice(AdminGetDeviceRequest adminGetDeviceRequest)
                             throws AmazonClientException,
                                    AmazonServiceException

Gets the device, as an administrator.

Parameters:

adminGetDeviceRequest -

Represents the request to get the device, as an administrator.

Returns:

adminGetDeviceResult The response from the AdminGetDevice service method, as returned by Amazon Cognito Your User Pool.

Throws:

ResourceNotFoundException

InvalidParameterException

InvalidUserPoolConfigurationException

TooManyRequestsException

InternalErrorException

NotAuthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

adminInitiateAuth

AdminInitiateAuthResult adminInitiateAuth(AdminInitiateAuthRequest adminInitiateAuthRequest)
                                   throws AmazonClientException,
                                          AmazonServiceException

Initiates the authentication flow, as an administrator.

Parameters:

adminInitiateAuthRequest -

Initiates the authorization request, as an administrator.

Returns:

adminInitiateAuthResult The response from the AdminInitiateAuth service method, as returned by Amazon Cognito Your User Pool.

Throws:

ResourceNotFoundException

InvalidParameterException

NotAuthorizedException

TooManyRequestsException

InternalErrorException

UnexpectedLambdaException

InvalidUserPoolConfigurationException

UserLambdaValidationException

InvalidLambdaResponseException

MFAMethodNotFoundException

InvalidSmsRoleAccessPolicyException

InvalidSmsRoleTrustRelationshipException

PasswordResetRequiredException

UserNotFoundException

UserNotConfirmedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

adminListDevices

AdminListDevicesResult adminListDevices(AdminListDevicesRequest adminListDevicesRequest)
                                 throws AmazonClientException,
                                        AmazonServiceException

Lists devices, as an administrator.

Parameters:

adminListDevicesRequest -

Represents the request to list devices, as an administrator.

Returns:

adminListDevicesResult The response from the AdminListDevices service method, as returned by Amazon Cognito Your User Pool.

Throws:

InvalidParameterException

ResourceNotFoundException

InvalidUserPoolConfigurationException

TooManyRequestsException

InternalErrorException

NotAuthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

adminRespondToAuthChallenge

AdminRespondToAuthChallengeResult adminRespondToAuthChallenge(AdminRespondToAuthChallengeRequest adminRespondToAuthChallengeRequest)
                                                       throws AmazonClientException,
                                                              AmazonServiceException

Responds to an authentication challenge, as an administrator.

Parameters:

adminRespondToAuthChallengeRequest -

The request to respond to the authentication challenge, as an administrator.

Returns:

adminRespondToAuthChallengeResult The response from the AdminRespondToAuthChallenge service method, as returned by Amazon Cognito Your User Pool.

Throws:

ResourceNotFoundException

InvalidParameterException

NotAuthorizedException

CodeMismatchException

ExpiredCodeException

UnexpectedLambdaException

InvalidPasswordException

UserLambdaValidationException

InvalidLambdaResponseException

TooManyRequestsException

InvalidUserPoolConfigurationException

InternalErrorException

MFAMethodNotFoundException

InvalidSmsRoleAccessPolicyException

InvalidSmsRoleTrustRelationshipException

AliasExistsException

PasswordResetRequiredException

UserNotFoundException

UserNotConfirmedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

adminSetUserSettings

AdminSetUserSettingsResult adminSetUserSettings(AdminSetUserSettingsRequest adminSetUserSettingsRequest)
                                         throws AmazonClientException,
                                                AmazonServiceException

Sets all the user settings for a specified user name. Works on any user.

Parameters:

adminSetUserSettingsRequest -

Represents the request to set user settings as an administrator.

Returns:

adminSetUserSettingsResult The response from the AdminSetUserSettings service method, as returned by Amazon Cognito Your User Pool.

Throws:

ResourceNotFoundException

InvalidParameterException

NotAuthorizedException

UserNotFoundException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

adminUpdateDeviceStatus

AdminUpdateDeviceStatusResult adminUpdateDeviceStatus(AdminUpdateDeviceStatusRequest adminUpdateDeviceStatusRequest)
                                               throws AmazonClientException,
                                                      AmazonServiceException

Updates the device status as an administrator.

Parameters:

adminUpdateDeviceStatusRequest -

The request to update the device status, as an administrator.

Returns:

adminUpdateDeviceStatusResult The response from the AdminUpdateDeviceStatus service method, as returned by Amazon Cognito Your User Pool.

Throws:

InvalidParameterException

ResourceNotFoundException

InvalidUserPoolConfigurationException

TooManyRequestsException

NotAuthorizedException

UserNotFoundException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

adminUserGlobalSignOut

AdminUserGlobalSignOutResult adminUserGlobalSignOut(AdminUserGlobalSignOutRequest adminUserGlobalSignOutRequest)
                                             throws AmazonClientException,
                                                    AmazonServiceException

Signs out users from all devices, as an administrator.

Parameters:

adminUserGlobalSignOutRequest -

The request to sign out of all devices, as an administrator.

Returns:

adminUserGlobalSignOutResult The response from the AdminUserGlobalSignOut service method, as returned by Amazon Cognito Your User Pool.

Throws:

ResourceNotFoundException

InvalidParameterException

TooManyRequestsException

NotAuthorizedException

UserNotFoundException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

associateSoftwareToken

AssociateSoftwareTokenResult associateSoftwareToken(AssociateSoftwareTokenRequest associateSoftwareTokenRequest)
                                             throws AmazonClientException,
                                                    AmazonServiceException

Parameters:

associateSoftwareTokenRequest -

Returns:

associateSoftwareTokenResult The response from the AssociateSoftwareToken service method, as returned by Amazon Cognito Your User Pool.

Throws:

InvalidParameterException

NotAuthorizedException

ResourceNotFoundException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

changePassword

ChangePasswordResult changePassword(ChangePasswordRequest changePasswordRequest)
                             throws AmazonClientException,
                                    AmazonServiceException

Changes the password for a specified user in a user pool.

Parameters:

changePasswordRequest -

Represents the request to change a user password.

Returns:

changePasswordResult The response from the ChangePassword service method, as returned by Amazon Cognito Your User Pool.

Throws:

ResourceNotFoundException

InvalidParameterException

InvalidPasswordException

NotAuthorizedException

TooManyRequestsException

LimitExceededException

PasswordResetRequiredException

UserNotFoundException

UserNotConfirmedException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

confirmDevice

ConfirmDeviceResult confirmDevice(ConfirmDeviceRequest confirmDeviceRequest)
                           throws AmazonClientException,
                                  AmazonServiceException

Confirms tracking of the device. This API call is the call that beings device tracking.

Parameters:

confirmDeviceRequest -

Confirms the device request.

Returns:

confirmDeviceResult The response from the ConfirmDevice service method, as returned by Amazon Cognito Your User Pool.

Throws:

ResourceNotFoundException

InvalidParameterException

NotAuthorizedException

InvalidPasswordException

InvalidLambdaResponseException

UsernameExistsException

InvalidUserPoolConfigurationException

TooManyRequestsException

PasswordResetRequiredException

UserNotFoundException

UserNotConfirmedException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

confirmForgotPassword

ConfirmForgotPasswordResult confirmForgotPassword(ConfirmForgotPasswordRequest confirmForgotPasswordRequest)
                                           throws AmazonClientException,
                                                  AmazonServiceException

Allows a user to enter a code provided when they reset their password to update their password.

Parameters:

confirmForgotPasswordRequest -

The request representing the confirmation for a password reset.

Returns:

confirmForgotPasswordResult The response from the ConfirmForgotPassword service method, as returned by Amazon Cognito Your User Pool.

Throws:

ResourceNotFoundException

UnexpectedLambdaException

UserLambdaValidationException

InvalidParameterException

InvalidPasswordException

NotAuthorizedException

CodeMismatchException

ExpiredCodeException

TooManyFailedAttemptsException

InvalidLambdaResponseException

TooManyRequestsException

LimitExceededException

UserNotFoundException

UserNotConfirmedException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

confirmSignUp

ConfirmSignUpResult confirmSignUp(ConfirmSignUpRequest confirmSignUpRequest)
                           throws AmazonClientException,
                                  AmazonServiceException

Confirms registration of a user and handles the existing alias from a previous user.

Parameters:

confirmSignUpRequest -

Represents the request to confirm registration of a user.

Returns:

confirmSignUpResult The response from the ConfirmSignUp service method, as returned by Amazon Cognito Your User Pool.

Throws:

ResourceNotFoundException

InvalidParameterException

UnexpectedLambdaException

UserLambdaValidationException

NotAuthorizedException

TooManyFailedAttemptsException

CodeMismatchException

ExpiredCodeException

InvalidLambdaResponseException

AliasExistsException

TooManyRequestsException

LimitExceededException

UserNotFoundException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

createUserImportJob

CreateUserImportJobResult createUserImportJob(CreateUserImportJobRequest createUserImportJobRequest)
                                       throws AmazonClientException,
                                              AmazonServiceException

Creates the user import job.

Parameters:

createUserImportJobRequest -

Represents the request to create the user import job.

Returns:

createUserImportJobResult The response from the CreateUserImportJob service method, as returned by Amazon Cognito Your User Pool.

Throws:

ResourceNotFoundException

InvalidParameterException

TooManyRequestsException

PreconditionNotMetException

NotAuthorizedException

LimitExceededException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

createUserPoolClient

CreateUserPoolClientResult createUserPoolClient(CreateUserPoolClientRequest createUserPoolClientRequest)
                                         throws AmazonClientException,
                                                AmazonServiceException

Creates the user pool client.

Parameters:

createUserPoolClientRequest -

Represents the request to create a user pool client.

Returns:

createUserPoolClientResult The response from the CreateUserPoolClient service method, as returned by Amazon Cognito Your User Pool.

Throws:

InvalidParameterException

ResourceNotFoundException

TooManyRequestsException

LimitExceededException

NotAuthorizedException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

deleteUser

void deleteUser(DeleteUserRequest deleteUserRequest)
         throws AmazonClientException,
                AmazonServiceException

Allows a user to delete one's self.

Parameters:

deleteUserRequest -

Represents the request to delete a user.

Throws:

ResourceNotFoundException

InvalidParameterException

NotAuthorizedException

TooManyRequestsException

PasswordResetRequiredException

UserNotFoundException

UserNotConfirmedException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

deleteUserAttributes

DeleteUserAttributesResult deleteUserAttributes(DeleteUserAttributesRequest deleteUserAttributesRequest)
                                         throws AmazonClientException,
                                                AmazonServiceException

Deletes the attributes for a user.

Parameters:

deleteUserAttributesRequest -

Represents the request to delete user attributes.

Returns:

deleteUserAttributesResult The response from the DeleteUserAttributes service method, as returned by Amazon Cognito Your User Pool.

Throws:

ResourceNotFoundException

InvalidParameterException

NotAuthorizedException

TooManyRequestsException

PasswordResetRequiredException

UserNotFoundException

UserNotConfirmedException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

deleteUserPool

void deleteUserPool(DeleteUserPoolRequest deleteUserPoolRequest)
             throws AmazonClientException,
                    AmazonServiceException

Deletes the specified Amazon Cognito user pool.

Parameters:

deleteUserPoolRequest -

Represents the request to delete a user pool.

Throws:

ResourceNotFoundException

InvalidParameterException

TooManyRequestsException

NotAuthorizedException

UserImportInProgressException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

deleteUserPoolClient

void deleteUserPoolClient(DeleteUserPoolClientRequest deleteUserPoolClientRequest)
                   throws AmazonClientException,
                          AmazonServiceException

Allows the developer to delete the user pool client.

Parameters:

deleteUserPoolClientRequest -

Represents the request to delete a user pool client.

Throws:

ResourceNotFoundException

InvalidParameterException

TooManyRequestsException

NotAuthorizedException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

describeUserImportJob

DescribeUserImportJobResult describeUserImportJob(DescribeUserImportJobRequest describeUserImportJobRequest)
                                           throws AmazonClientException,
                                                  AmazonServiceException

Describes the user import job.

Parameters:

describeUserImportJobRequest -

Represents the request to describe the user import job.

Returns:

describeUserImportJobResult The response from the DescribeUserImportJob service method, as returned by Amazon Cognito Your User Pool.

Throws:

ResourceNotFoundException

InvalidParameterException

TooManyRequestsException

NotAuthorizedException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

describeUserPoolClient

DescribeUserPoolClientResult describeUserPoolClient(DescribeUserPoolClientRequest describeUserPoolClientRequest)
                                             throws AmazonClientException,
                                                    AmazonServiceException

Client method for returning the configuration information and metadata of the specified user pool client.

Parameters:

describeUserPoolClientRequest -

Represents the request to describe a user pool client.

Returns:

describeUserPoolClientResult The response from the DescribeUserPoolClient service method, as returned by Amazon Cognito Your User Pool.

Throws:

ResourceNotFoundException

InvalidParameterException

TooManyRequestsException

NotAuthorizedException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

forgetDevice

void forgetDevice(ForgetDeviceRequest forgetDeviceRequest)
           throws AmazonClientException,
                  AmazonServiceException

Forgets the specified device.

Parameters:

forgetDeviceRequest -

Represents the request to forget the device.

Throws:

ResourceNotFoundException

InvalidParameterException

NotAuthorizedException

TooManyRequestsException

InvalidUserPoolConfigurationException

PasswordResetRequiredException

UserNotFoundException

UserNotConfirmedException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

forgotPassword

ForgotPasswordResult forgotPassword(ForgotPasswordRequest forgotPasswordRequest)
                             throws AmazonClientException,
                                    AmazonServiceException

Retrieves the password for the specified client ID or username.

Parameters:

forgotPasswordRequest -

Represents the request to reset a user's password.

Returns:

forgotPasswordResult The response from the ForgotPassword service method, as returned by Amazon Cognito Your User Pool.

Throws:

ResourceNotFoundException

InvalidParameterException

UnexpectedLambdaException

UserLambdaValidationException

NotAuthorizedException

InvalidLambdaResponseException

TooManyRequestsException

LimitExceededException

InvalidSmsRoleAccessPolicyException

InvalidSmsRoleTrustRelationshipException

InvalidEmailRoleAccessPolicyException

CodeDeliveryFailureException

UserNotFoundException

UserNotConfirmedException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

getCSVHeader

GetCSVHeaderResult getCSVHeader(GetCSVHeaderRequest getCSVHeaderRequest)
                         throws AmazonClientException,
                                AmazonServiceException

Gets the header information for the .csv file to be used as input for the user import job.

Parameters:

getCSVHeaderRequest -

Represents the request to get the header information for the .csv file for the user import job.

Returns:

getCSVHeaderResult The response from the GetCSVHeader service method, as returned by Amazon Cognito Your User Pool.

Throws:

ResourceNotFoundException

InvalidParameterException

TooManyRequestsException

NotAuthorizedException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

getDevice

GetDeviceResult getDevice(GetDeviceRequest getDeviceRequest)
                   throws AmazonClientException,
                          AmazonServiceException

Gets the device.

Parameters:

getDeviceRequest -

Represents the request to get the device.

Returns:

getDeviceResult The response from the GetDevice service method, as returned by Amazon Cognito Your User Pool.

Throws:

ResourceNotFoundException

InvalidParameterException

InvalidUserPoolConfigurationException

NotAuthorizedException

TooManyRequestsException

PasswordResetRequiredException

UserNotFoundException

UserNotConfirmedException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

getUser

GetUserResult getUser(GetUserRequest getUserRequest)
               throws AmazonClientException,
                      AmazonServiceException

Gets the user attributes and metadata for a user.

Parameters:

getUserRequest -

Represents the request to get information about the user.

Returns:

getUserResult The response from the GetUser service method, as returned by Amazon Cognito Your User Pool.

Throws:

ResourceNotFoundException

InvalidParameterException

NotAuthorizedException

TooManyRequestsException

PasswordResetRequiredException

UserNotFoundException

UserNotConfirmedException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

getUserAttributeVerificationCode

GetUserAttributeVerificationCodeResult getUserAttributeVerificationCode(GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest)
                                                                 throws AmazonClientException,
                                                                        AmazonServiceException

Gets the user attribute verification code for the specified attribute name.

Parameters:

getUserAttributeVerificationCodeRequest -

Represents the request to get user attribute verification.

Returns:

getUserAttributeVerificationCodeResult The response from the GetUserAttributeVerificationCode service method, as returned by Amazon Cognito Your User Pool.

Throws:

ResourceNotFoundException

InvalidParameterException

TooManyRequestsException

NotAuthorizedException

UnexpectedLambdaException

UserLambdaValidationException

InvalidLambdaResponseException

InvalidSmsRoleAccessPolicyException

InvalidSmsRoleTrustRelationshipException

InvalidEmailRoleAccessPolicyException

CodeDeliveryFailureException

LimitExceededException

PasswordResetRequiredException

UserNotFoundException

UserNotConfirmedException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

globalSignOut

GlobalSignOutResult globalSignOut(GlobalSignOutRequest globalSignOutRequest)
                           throws AmazonClientException,
                                  AmazonServiceException

Signs out users from all devices.

Parameters:

globalSignOutRequest -

Represents the request to sign out all devices.

Returns:

globalSignOutResult The response from the GlobalSignOut service method, as returned by Amazon Cognito Your User Pool.

Throws:

ResourceNotFoundException

InvalidParameterException

NotAuthorizedException

TooManyRequestsException

PasswordResetRequiredException

UserNotConfirmedException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

initiateAuth

InitiateAuthResult initiateAuth(InitiateAuthRequest initiateAuthRequest)
                         throws AmazonClientException,
                                AmazonServiceException

Initiates the authentication flow.

Parameters:

initiateAuthRequest -

Initiates the authentication request.

Returns:

initiateAuthResult The response from the InitiateAuth service method, as returned by Amazon Cognito Your User Pool.

Throws:

ResourceNotFoundException

InvalidParameterException

NotAuthorizedException

TooManyRequestsException

UnexpectedLambdaException

InvalidUserPoolConfigurationException

UserLambdaValidationException

InvalidLambdaResponseException

PasswordResetRequiredException

UserNotFoundException

UserNotConfirmedException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

listDevices

ListDevicesResult listDevices(ListDevicesRequest listDevicesRequest)
                       throws AmazonClientException,
                              AmazonServiceException

Lists the devices.

Parameters:

listDevicesRequest -

Represents the request to list the devices.

Returns:

listDevicesResult The response from the ListDevices service method, as returned by Amazon Cognito Your User Pool.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

InvalidUserPoolConfigurationException

TooManyRequestsException

PasswordResetRequiredException

UserNotFoundException

UserNotConfirmedException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

listUserImportJobs

ListUserImportJobsResult listUserImportJobs(ListUserImportJobsRequest listUserImportJobsRequest)
                                     throws AmazonClientException,
                                            AmazonServiceException

Lists the user import jobs.

Parameters:

listUserImportJobsRequest -

Represents the request to list the user import jobs.

Returns:

listUserImportJobsResult The response from the ListUserImportJobs service method, as returned by Amazon Cognito Your User Pool.

Throws:

ResourceNotFoundException

InvalidParameterException

TooManyRequestsException

NotAuthorizedException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

listUserPoolClients

ListUserPoolClientsResult listUserPoolClients(ListUserPoolClientsRequest listUserPoolClientsRequest)
                                       throws AmazonClientException,
                                              AmazonServiceException

Lists the clients that have been created for the specified user pool.

Parameters:

listUserPoolClientsRequest -

Represents the request to list the user pool clients.

Returns:

listUserPoolClientsResult The response from the ListUserPoolClients service method, as returned by Amazon Cognito Your User Pool.

Throws:

InvalidParameterException

ResourceNotFoundException

TooManyRequestsException

NotAuthorizedException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

listUsers

ListUsersResult listUsers(ListUsersRequest listUsersRequest)
                   throws AmazonClientException,
                          AmazonServiceException

Lists the users in the Amazon Cognito user pool.

Parameters:

listUsersRequest -

Represents the request to list users.

Returns:

listUsersResult The response from the ListUsers service method, as returned by Amazon Cognito Your User Pool.

Throws:

InvalidParameterException

ResourceNotFoundException

TooManyRequestsException

NotAuthorizedException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

resendConfirmationCode

ResendConfirmationCodeResult resendConfirmationCode(ResendConfirmationCodeRequest resendConfirmationCodeRequest)
                                             throws AmazonClientException,
                                                    AmazonServiceException

Resends the confirmation (for confirmation of registration) to a specific user in the user pool.

Parameters:

resendConfirmationCodeRequest -

Represents the request to resend the confirmation code.

Returns:

resendConfirmationCodeResult The response from the ResendConfirmationCode service method, as returned by Amazon Cognito Your User Pool.

Throws:

ResourceNotFoundException

InvalidParameterException

UnexpectedLambdaException

UserLambdaValidationException

NotAuthorizedException

InvalidLambdaResponseException

TooManyRequestsException

LimitExceededException

InvalidSmsRoleAccessPolicyException

InvalidSmsRoleTrustRelationshipException

InvalidEmailRoleAccessPolicyException

CodeDeliveryFailureException

UserNotFoundException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

respondToAuthChallenge

RespondToAuthChallengeResult respondToAuthChallenge(RespondToAuthChallengeRequest respondToAuthChallengeRequest)
                                             throws AmazonClientException,
                                                    AmazonServiceException

Responds to the authentication challenge.

Parameters:

respondToAuthChallengeRequest -

The request to respond to an authentication challenge.

Returns:

respondToAuthChallengeResult The response from the RespondToAuthChallenge service method, as returned by Amazon Cognito Your User Pool.

Throws:

ResourceNotFoundException

InvalidParameterException

NotAuthorizedException

CodeMismatchException

ExpiredCodeException

UnexpectedLambdaException

UserLambdaValidationException

InvalidPasswordException

InvalidLambdaResponseException

TooManyRequestsException

InvalidUserPoolConfigurationException

MFAMethodNotFoundException

PasswordResetRequiredException

UserNotFoundException

UserNotConfirmedException

InvalidSmsRoleAccessPolicyException

InvalidSmsRoleTrustRelationshipException

AliasExistsException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

setUserMFAPreference

SetUserMFAPreferenceResult setUserMFAPreference(SetUserMFAPreferenceRequest setUserMFAPreferenceRequest)
                                         throws AmazonClientException,
                                                AmazonServiceException

Parameters:

setUserMFAPreferenceRequest -

Returns:

setUserMFAPreferenceResult The response from the SetUserMFAPreference service method, as returned by Amazon Cognito Your User Pool.

Throws:

ResourceNotFoundException

InvalidParameterException

NotAuthorizedException

PasswordResetRequiredException

UserNotFoundException

UserNotConfirmedException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

setUserSettings

SetUserSettingsResult setUserSettings(SetUserSettingsRequest setUserSettingsRequest)
                               throws AmazonClientException,
                                      AmazonServiceException

Sets the user settings like multi-factor authentication (MFA). If MFA is to be removed for a particular attribute pass the attribute with code delivery as null. If null list is passed, all MFA options are removed.

Parameters:

setUserSettingsRequest -

Represents the request to set user settings.

Returns:

setUserSettingsResult The response from the SetUserSettings service method, as returned by Amazon Cognito Your User Pool.

Throws:

ResourceNotFoundException

InvalidParameterException

NotAuthorizedException

PasswordResetRequiredException

UserNotFoundException

UserNotConfirmedException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

signUp

SignUpResult signUp(SignUpRequest signUpRequest)
             throws AmazonClientException,
                    AmazonServiceException

Registers the user in the specified user pool and creates a user name, password, and user attributes.

Parameters:

signUpRequest -

Represents the request to register a user.

Returns:

signUpResult The response from the SignUp service method, as returned by Amazon Cognito Your User Pool.

Throws:

ResourceNotFoundException

InvalidParameterException

UnexpectedLambdaException

UserLambdaValidationException

NotAuthorizedException

InvalidPasswordException

InvalidLambdaResponseException

UsernameExistsException

TooManyRequestsException

InternalErrorException

InvalidSmsRoleAccessPolicyException

InvalidSmsRoleTrustRelationshipException

InvalidEmailRoleAccessPolicyException

CodeDeliveryFailureException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

startUserImportJob

StartUserImportJobResult startUserImportJob(StartUserImportJobRequest startUserImportJobRequest)
                                     throws AmazonClientException,
                                            AmazonServiceException

Starts the user import.

Parameters:

startUserImportJobRequest -

Represents the request to start the user import job.

Returns:

startUserImportJobResult The response from the StartUserImportJob service method, as returned by Amazon Cognito Your User Pool.

Throws:

ResourceNotFoundException

InvalidParameterException

TooManyRequestsException

InternalErrorException

PreconditionNotMetException

NotAuthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

stopUserImportJob

StopUserImportJobResult stopUserImportJob(StopUserImportJobRequest stopUserImportJobRequest)
                                   throws AmazonClientException,
                                          AmazonServiceException

Stops the user import job.

Parameters:

stopUserImportJobRequest -

Represents the request to stop the user import job.

Returns:

stopUserImportJobResult The response from the StopUserImportJob service method, as returned by Amazon Cognito Your User Pool.

Throws:

ResourceNotFoundException

InvalidParameterException

TooManyRequestsException

InternalErrorException

PreconditionNotMetException

NotAuthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

updateDeviceStatus

UpdateDeviceStatusResult updateDeviceStatus(UpdateDeviceStatusRequest updateDeviceStatusRequest)
                                     throws AmazonClientException,
                                            AmazonServiceException

Updates the device status.

Parameters:

updateDeviceStatusRequest -

Represents the request to update the device status.

Returns:

updateDeviceStatusResult The response from the UpdateDeviceStatus service method, as returned by Amazon Cognito Your User Pool.

Throws:

InvalidParameterException

ResourceNotFoundException

NotAuthorizedException

InvalidUserPoolConfigurationException

TooManyRequestsException

PasswordResetRequiredException

UserNotFoundException

UserNotConfirmedException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

updateUserAttributes

UpdateUserAttributesResult updateUserAttributes(UpdateUserAttributesRequest updateUserAttributesRequest)
                                         throws AmazonClientException,
                                                AmazonServiceException

Allows a user to update a specific attribute (one at a time).

Parameters:

updateUserAttributesRequest -

Represents the request to update user attributes.

Returns:

updateUserAttributesResult The response from the UpdateUserAttributes service method, as returned by Amazon Cognito Your User Pool.

Throws:

ResourceNotFoundException

InvalidParameterException

CodeMismatchException

ExpiredCodeException

NotAuthorizedException

UnexpectedLambdaException

UserLambdaValidationException

InvalidLambdaResponseException

TooManyRequestsException

AliasExistsException

InvalidSmsRoleAccessPolicyException

InvalidSmsRoleTrustRelationshipException

InvalidEmailRoleAccessPolicyException

CodeDeliveryFailureException

PasswordResetRequiredException

UserNotFoundException

UserNotConfirmedException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

updateUserPoolClient

UpdateUserPoolClientResult updateUserPoolClient(UpdateUserPoolClientRequest updateUserPoolClientRequest)
                                         throws AmazonClientException,
                                                AmazonServiceException

Allows the developer to update the specified user pool client and password policy.

Parameters:

updateUserPoolClientRequest -

Represents the request to update the user pool client.

Returns:

updateUserPoolClientResult The response from the UpdateUserPoolClient service method, as returned by Amazon Cognito Your User Pool.

Throws:

ResourceNotFoundException

InvalidParameterException

TooManyRequestsException

NotAuthorizedException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

verifySoftwareToken

VerifySoftwareTokenResult verifySoftwareToken(VerifySoftwareTokenRequest verifySoftwareTokenRequest)
                                       throws AmazonClientException,
                                              AmazonServiceException

Parameters:

verifySoftwareTokenRequest -

Returns:

verifySoftwareTokenResult The response from the VerifySoftwareToken service method, as returned by Amazon Cognito Your User Pool.

Throws:

ResourceNotFoundException

InvalidParameterException

InvalidUserPoolConfigurationException

EnableSoftwareTokenMFAException

SoftwareTokenMFANotFoundException

CodeMismatchException

ExpiredCodeException

NotAuthorizedException

TooManyRequestsException

LimitExceededException

PasswordResetRequiredException

UserNotFoundException

UserNotConfirmedException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

verifyUserAttribute

VerifyUserAttributeResult verifyUserAttribute(VerifyUserAttributeRequest verifyUserAttributeRequest)
                                       throws AmazonClientException,
                                              AmazonServiceException

Verifies the specified user attributes in the user pool.

Parameters:

verifyUserAttributeRequest -

Represents the request to verify user attributes.

Returns:

verifyUserAttributeResult The response from the VerifyUserAttribute service method, as returned by Amazon Cognito Your User Pool.

Throws:

ResourceNotFoundException

InvalidParameterException

CodeMismatchException

ExpiredCodeException

NotAuthorizedException

TooManyRequestsException

LimitExceededException

PasswordResetRequiredException

UserNotFoundException

UserNotConfirmedException

InternalErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Cognito Your User Pool indicating either a problem with the data in the request, or a server side issue.

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.