com.amazonaws.services.cognitoidp

Interface AWSCognitoIdentityProvider

All Known Subinterfaces:

AWSCognitoIdentityProviderAsync

All Known Implementing Classes:

AbstractAWSCognitoIdentityProvider, AbstractAWSCognitoIdentityProviderAsync, AWSCognitoIdentityProviderAsyncClient, AWSCognitoIdentityProviderClient

public interface AWSCognitoIdentityProvider

Interface for accessing Amazon Cognito Identity Provider.

You can create a user pool in Amazon Cognito Identity 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 Identity, which is a new capability that is available as a beta.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Methods

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.
AdminDeleteUserResult	adminDeleteUser(AdminDeleteUserRequest adminDeleteUserRequest) Deletes a user as an administrator.
AdminDeleteUserAttributesResult	adminDeleteUserAttributes(AdminDeleteUserAttributesRequest adminDeleteUserAttributesRequest) Deletes the user attributes in a user pool as an administrator.
AdminDisableUserResult	adminDisableUser(AdminDisableUserRequest adminDisableUserRequest) Disables the specified user as an administrator.
AdminEnableUserResult	adminEnableUser(AdminEnableUserRequest adminEnableUserRequest) Enables the specified user as an administrator.
AdminGetUserResult	adminGetUser(AdminGetUserRequest adminGetUserRequest) Gets the specified user by user name in a user pool as an administrator.
AdminResetUserPasswordResult	adminResetUserPassword(AdminResetUserPasswordRequest adminResetUserPasswordRequest) Resets the specified user's password in a user pool as an administrator.
AdminSetUserSettingsResult	adminSetUserSettings(AdminSetUserSettingsRequest adminSetUserSettingsRequest) Sets all the user settings for a specified user name.
AdminUpdateUserAttributesResult	adminUpdateUserAttributes(AdminUpdateUserAttributesRequest adminUpdateUserAttributesRequest) Updates the specified user's attributes, including developer attributes, as an administrator.
ChangePasswordResult	changePassword(ChangePasswordRequest changePasswordRequest) Changes the password for a specified user in a user pool.
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.
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.
DeleteUserResult	deleteUser(DeleteUserRequest deleteUserRequest) Allows a user to delete one's self.
DeleteUserAttributesResult	deleteUserAttributes(DeleteUserAttributesRequest deleteUserAttributesRequest) Deletes the attributes for a user.
DeleteUserPoolResult	deleteUserPool(DeleteUserPoolRequest deleteUserPoolRequest) Deletes the specified Amazon Cognito user pool.
DeleteUserPoolClientResult	deleteUserPoolClient(DeleteUserPoolClientRequest deleteUserPoolClientRequest) Allows the developer to delete the user pool client.
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 client.
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.
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.
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.
ResendConfirmationCodeResult	resendConfirmationCode(ResendConfirmationCodeRequest resendConfirmationCodeRequest) Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
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.
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.
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) Allows the developer to update the specified user pool client and password policy.
VerifyUserAttributeResult	verifyUserAttribute(VerifyUserAttributeRequest verifyUserAttributeRequest) Verifies the specified user attributes in the user pool.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

setEndpoint

void setEndpoint(String endpoint)

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.

setRegion

void setRegion(Region region)

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. Must not be null and must be a region where the service is available.

See Also:

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

addCustomAttributes

AddCustomAttributesResult addCustomAttributes(AddCustomAttributesRequest addCustomAttributesRequest)

Adds additional user attributes to the user pool schema.

Parameters:

addCustomAttributesRequest - Represents the request to add custom attributes.

Returns:

Result of the AddCustomAttributes operation returned by the service.

Throws:

ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.

InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.

InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.

adminConfirmSignUp

AdminConfirmSignUpResult adminConfirmSignUp(AdminConfirmSignUpRequest adminConfirmSignUpRequest)

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:

Result of the AdminConfirmSignUp operation returned by the service.

Throws:

ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.

InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

UnexpectedLambdaException - This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.

UserLambdaValidationException - This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.

NotAuthorizedException - This exception gets thrown when a user is not authorized.

TooManyFailedAttemptsException - This exception gets thrown when the user has made too many failed attempts for a given action (e.g., sign in).

InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.

TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.

LimitExceededException - This exception is thrown when a user exceeds the limit for a requested AWS resource.

InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.

adminDeleteUser

AdminDeleteUserResult adminDeleteUser(AdminDeleteUserRequest adminDeleteUserRequest)

Deletes a user as an administrator. Works on any user.

Parameters:

adminDeleteUserRequest - Represents the request to delete a user as an administrator.

Returns:

Result of the AdminDeleteUser operation returned by the service.

Throws:

ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.

InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.

InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.

adminDeleteUserAttributes

AdminDeleteUserAttributesResult adminDeleteUserAttributes(AdminDeleteUserAttributesRequest adminDeleteUserAttributesRequest)

Deletes the user attributes in a user pool as an administrator. Works on any user.

Parameters:

adminDeleteUserAttributesRequest - Represents the request to delete user attributes as an administrator.

Returns:

Result of the AdminDeleteUserAttributes operation returned by the service.

Throws:

ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.

InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.

InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.

adminDisableUser

AdminDisableUserResult adminDisableUser(AdminDisableUserRequest adminDisableUserRequest)

Disables the specified user as an administrator. Works on any user.

Parameters:

adminDisableUserRequest - Represents the request to disable any user as an administrator.

Returns:

Result of the AdminDisableUser operation returned by the service.

Throws:

ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.

InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.

InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.

adminEnableUser

AdminEnableUserResult adminEnableUser(AdminEnableUserRequest adminEnableUserRequest)

Enables the specified user as an administrator. Works on any user.

Parameters:

adminEnableUserRequest - Represents the request that enables the user as an administrator.

Returns:

Result of the AdminEnableUser operation returned by the service.

Throws:

ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.

InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.

InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.

adminGetUser

AdminGetUserResult adminGetUser(AdminGetUserRequest adminGetUserRequest)

Gets the specified user by user name in a user pool as an administrator. Works on any user.

Parameters:

adminGetUserRequest - Represents the request to get the specified user as an administrator.

Returns:

Result of the AdminGetUser operation returned by the service.

Throws:

ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.

InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.

InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.

adminResetUserPassword

AdminResetUserPasswordResult adminResetUserPassword(AdminResetUserPasswordRequest adminResetUserPasswordRequest)

Resets the specified user's password in a user pool as an administrator. Works on any user.

Parameters:

adminResetUserPasswordRequest - Represents the request to reset a user's password as an administrator.

Returns:

Result of the AdminResetUserPassword operation returned by the service.

Throws:

ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.

InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

UnexpectedLambdaException - This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.

UserLambdaValidationException - This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.

NotAuthorizedException - This exception gets thrown when a user is not authorized.

InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.

TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.

LimitExceededException - This exception is thrown when a user exceeds the limit for a requested AWS resource.

InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.

adminSetUserSettings

AdminSetUserSettingsResult adminSetUserSettings(AdminSetUserSettingsRequest adminSetUserSettingsRequest)

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:

Result of the AdminSetUserSettings operation returned by the service.

Throws:

ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.

InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

NotAuthorizedException - This exception gets thrown when a user is not authorized.

adminUpdateUserAttributes

AdminUpdateUserAttributesResult adminUpdateUserAttributes(AdminUpdateUserAttributesRequest adminUpdateUserAttributesRequest)

Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.

Parameters:

adminUpdateUserAttributesRequest - Represents the request to update the user's attributes as an administrator.

Returns:

Result of the AdminUpdateUserAttributes operation returned by the service.

Throws:

ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.

InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

UnexpectedLambdaException - This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.

UserLambdaValidationException - This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.

InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.

AliasExistsException - This exception is thrown when a user tries to confirm the account with an email or phone number that has already been supplied as an alias from a different account. This exception tells user that an account with this email or phone already exists.

TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.

InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.

changePassword

ChangePasswordResult changePassword(ChangePasswordRequest changePasswordRequest)

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

Parameters:

changePasswordRequest - Represents the request to change a user password.

Returns:

Result of the ChangePassword operation returned by the service.

Throws:

ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.

InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

InvalidPasswordException - This exception is thrown when the Amazon Cognito service encounters an invalid password.

NotAuthorizedException - This exception gets thrown when a user is not authorized.

TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.

InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.

confirmForgotPassword

ConfirmForgotPasswordResult confirmForgotPassword(ConfirmForgotPasswordRequest confirmForgotPasswordRequest)

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:

Result of the ConfirmForgotPassword operation returned by the service.

Throws:

ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.

UnexpectedLambdaException - This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.

UserLambdaValidationException - This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.

InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

InvalidPasswordException - This exception is thrown when the Amazon Cognito service encounters an invalid password.

NotAuthorizedException - This exception gets thrown when a user is not authorized.

CodeMismatchException - This exception is thrown if the provided code does not match what the server was expecting.

ExpiredCodeException - This exception is thrown if a code has expired.

TooManyFailedAttemptsException - This exception gets thrown when the user has made too many failed attempts for a given action (e.g., sign in).

InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.

TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.

LimitExceededException - This exception is thrown when a user exceeds the limit for a requested AWS resource.

InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.

confirmSignUp

ConfirmSignUpResult confirmSignUp(ConfirmSignUpRequest confirmSignUpRequest)

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:

Result of the ConfirmSignUp operation returned by the service.

Throws:

ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.

InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

UnexpectedLambdaException - This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.

UserLambdaValidationException - This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.

NotAuthorizedException - This exception gets thrown when a user is not authorized.

TooManyFailedAttemptsException - This exception gets thrown when the user has made too many failed attempts for a given action (e.g., sign in).

CodeMismatchException - This exception is thrown if the provided code does not match what the server was expecting.

ExpiredCodeException - This exception is thrown if a code has expired.

InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.

AliasExistsException - This exception is thrown when a user tries to confirm the account with an email or phone number that has already been supplied as an alias from a different account. This exception tells user that an account with this email or phone already exists.

TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.

LimitExceededException - This exception is thrown when a user exceeds the limit for a requested AWS resource.

InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.

createUserPool

CreateUserPoolResult createUserPool(CreateUserPoolRequest createUserPoolRequest)

Creates a new Amazon Cognito user pool and sets the password policy for the pool.

Parameters:

createUserPoolRequest - Represents the request to create a user pool.

Returns:

Result of the CreateUserPool operation returned by the service.

Throws:

InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.

InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.

LimitExceededException - This exception is thrown when a user exceeds the limit for a requested AWS resource.

createUserPoolClient

CreateUserPoolClientResult createUserPoolClient(CreateUserPoolClientRequest createUserPoolClientRequest)

Creates the user pool client.

Parameters:

createUserPoolClientRequest - Represents the request to create a user pool client.

Returns:

Result of the CreateUserPoolClient operation returned by the service.

Throws:

InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.

TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.

LimitExceededException - This exception is thrown when a user exceeds the limit for a requested AWS resource.

InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.

deleteUser

DeleteUserResult deleteUser(DeleteUserRequest deleteUserRequest)

Allows a user to delete one's self.

Parameters:

deleteUserRequest - Represents the request to delete a user.

Returns:

Result of the DeleteUser operation returned by the service.

Throws:

ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.

InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

NotAuthorizedException - This exception gets thrown when a user is not authorized.

TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.

InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.

deleteUserAttributes

DeleteUserAttributesResult deleteUserAttributes(DeleteUserAttributesRequest deleteUserAttributesRequest)

Deletes the attributes for a user.

Parameters:

deleteUserAttributesRequest - Represents the request to delete user attributes.

Returns:

Result of the DeleteUserAttributes operation returned by the service.

Throws:

ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.

InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

NotAuthorizedException - This exception gets thrown when a user is not authorized.

TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.

InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.

deleteUserPool

DeleteUserPoolResult deleteUserPool(DeleteUserPoolRequest deleteUserPoolRequest)

Deletes the specified Amazon Cognito user pool.

Parameters:

deleteUserPoolRequest - Represents the request to delete a user pool.

Returns:

Result of the DeleteUserPool operation returned by the service.

Throws:

ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.

InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.

InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.

deleteUserPoolClient

DeleteUserPoolClientResult deleteUserPoolClient(DeleteUserPoolClientRequest deleteUserPoolClientRequest)

Allows the developer to delete the user pool client.

Parameters:

deleteUserPoolClientRequest - Represents the request to delete a user pool client.

Returns:

Result of the DeleteUserPoolClient operation returned by the service.

Throws:

ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.

InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.

InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.

describeUserPool

DescribeUserPoolResult describeUserPool(DescribeUserPoolRequest describeUserPoolRequest)

Returns the configuration information and metadata of the specified user pool.

Parameters:

describeUserPoolRequest - Represents the request to describe the user pool.

Returns:

Result of the DescribeUserPool operation returned by the service.

Throws:

ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.

InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.

InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.

describeUserPoolClient

DescribeUserPoolClientResult describeUserPoolClient(DescribeUserPoolClientRequest describeUserPoolClientRequest)

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:

Result of the DescribeUserPoolClient operation returned by the service.

Throws:

ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.

InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.

InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.

forgotPassword

ForgotPasswordResult forgotPassword(ForgotPasswordRequest forgotPasswordRequest)

Retrieves the password for the specified client ID or username.

Parameters:

forgotPasswordRequest - Represents the request to reset a user's password.

Returns:

Result of the ForgotPassword operation returned by the service.

Throws:

ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.

InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

UnexpectedLambdaException - This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.

UserLambdaValidationException - This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.

NotAuthorizedException - This exception gets thrown when a user is not authorized.

InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.

TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.

LimitExceededException - This exception is thrown when a user exceeds the limit for a requested AWS resource.

InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.

getUser

GetUserResult getUser(GetUserRequest getUserRequest)

Gets the user attributes and metadata for a user.

Parameters:

getUserRequest - Represents the request to get information about the user.

Returns:

Result of the GetUser operation returned by the service.

Throws:

ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.

InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

NotAuthorizedException - This exception gets thrown when a user is not authorized.

TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.

InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.

getUserAttributeVerificationCode

GetUserAttributeVerificationCodeResult getUserAttributeVerificationCode(GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest)

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

Parameters:

getUserAttributeVerificationCodeRequest - Represents the request to get user attribute verification.

Returns:

Result of the GetUserAttributeVerificationCode operation returned by the service.

Throws:

ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.

InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.

NotAuthorizedException - This exception gets thrown when a user is not authorized.

UnexpectedLambdaException - This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.

UserLambdaValidationException - This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.

InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.

InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.

listUserPoolClients

ListUserPoolClientsResult listUserPoolClients(ListUserPoolClientsRequest listUserPoolClientsRequest)

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

Parameters:

listUserPoolClientsRequest - Represents the request to list the user pool clients.

Returns:

Result of the ListUserPoolClients operation returned by the service.

Throws:

InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.

TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.

InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.

listUserPools

ListUserPoolsResult listUserPools(ListUserPoolsRequest listUserPoolsRequest)

Lists the user pools associated with an AWS account.

Parameters:

listUserPoolsRequest - Represents the request to list user pools.

Returns:

Result of the ListUserPools operation returned by the service.

Throws:

InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.

InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.

listUsers

ListUsersResult listUsers(ListUsersRequest listUsersRequest)

Lists the users in the Amazon Cognito user pool.

Parameters:

listUsersRequest - Represents the request to list users.

Returns:

Result of the ListUsers operation returned by the service.

Throws:

InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.

TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.

InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.

resendConfirmationCode

ResendConfirmationCodeResult resendConfirmationCode(ResendConfirmationCodeRequest resendConfirmationCodeRequest)

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:

Result of the ResendConfirmationCode operation returned by the service.

Throws:

ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.

InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

UnexpectedLambdaException - This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.

UserLambdaValidationException - This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.

NotAuthorizedException - This exception gets thrown when a user is not authorized.

InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.

TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.

LimitExceededException - This exception is thrown when a user exceeds the limit for a requested AWS resource.

InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.

setUserSettings

SetUserSettingsResult setUserSettings(SetUserSettingsRequest setUserSettingsRequest)

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:

Result of the SetUserSettings operation returned by the service.

Throws:

ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.

InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

NotAuthorizedException - This exception gets thrown when a user is not authorized.

signUp

SignUpResult signUp(SignUpRequest signUpRequest)

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:

Result of the SignUp operation returned by the service.

Throws:

ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.

InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

UnexpectedLambdaException - This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.

UserLambdaValidationException - This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.

NotAuthorizedException - This exception gets thrown when a user is not authorized.

InvalidPasswordException - This exception is thrown when the Amazon Cognito service encounters an invalid password.

InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.

UsernameExistsException - This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.

TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.

InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.

updateUserAttributes

UpdateUserAttributesResult updateUserAttributes(UpdateUserAttributesRequest updateUserAttributesRequest)

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

Parameters:

updateUserAttributesRequest - Represents the request to update user attributes.

Returns:

Result of the UpdateUserAttributes operation returned by the service.

Throws:

ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.

InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

CodeMismatchException - This exception is thrown if the provided code does not match what the server was expecting.

ExpiredCodeException - This exception is thrown if a code has expired.

NotAuthorizedException - This exception gets thrown when a user is not authorized.

UnexpectedLambdaException - This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.

UserLambdaValidationException - This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.

InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.

TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.

AliasExistsException - This exception is thrown when a user tries to confirm the account with an email or phone number that has already been supplied as an alias from a different account. This exception tells user that an account with this email or phone already exists.

InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.

updateUserPool

UpdateUserPoolResult updateUserPool(UpdateUserPoolRequest updateUserPoolRequest)

Updates the specified user pool with the specified attributes.

Parameters:

updateUserPoolRequest - Represents the request to update the user pool.

Returns:

Result of the UpdateUserPool operation returned by the service.

Throws:

ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.

InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

ConcurrentModificationException - This exception is thrown if two or more modifications are happening concurrently.

TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.

InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.

updateUserPoolClient

UpdateUserPoolClientResult updateUserPoolClient(UpdateUserPoolClientRequest updateUserPoolClientRequest)

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:

Result of the UpdateUserPoolClient operation returned by the service.

Throws:

ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.

InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.

InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.

verifyUserAttribute

VerifyUserAttributeResult verifyUserAttribute(VerifyUserAttributeRequest verifyUserAttributeRequest)

Verifies the specified user attributes in the user pool.

Parameters:

verifyUserAttributeRequest - Represents the request to verify user attributes.

Returns:

Result of the VerifyUserAttribute operation returned by the service.

Throws:

ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.

InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

CodeMismatchException - This exception is thrown if the provided code does not match what the server was expecting.

ExpiredCodeException - This exception is thrown if a code has expired.

NotAuthorizedException - This exception gets thrown when a user is not authorized.

TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.

InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.

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.