Class AWSCognitoIdentityProviderClient
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceClient
-
- com.amazonaws.services.cognitoidp.AWSCognitoIdentityProviderClient
-
- All Implemented Interfaces:
AWSCognitoIdentityProvider
- Direct Known Subclasses:
AWSCognitoIdentityProviderAsyncClient
@ThreadSafe public class AWSCognitoIdentityProviderClient extends AmazonWebServiceClient implements AWSCognitoIdentityProvider
Client for accessing Amazon Cognito Identity Provider. All service calls made using this client are blocking, and will not return until the service call completes.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 Description protected static ClientConfigurationFactory
configFactory
Client configuration factory providing ClientConfigurations tailored to this client-
Fields inherited from class com.amazonaws.AmazonWebServiceClient
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
-
-
Constructor Summary
Constructors Constructor Description AWSCognitoIdentityProviderClient()
Constructs a new client to invoke service methods on Amazon Cognito Identity Provider.AWSCognitoIdentityProviderClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on Amazon Cognito Identity Provider using the specified AWS account credentials.AWSCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on Amazon Cognito Identity Provider using the specified AWS account credentials provider.AWSCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon Cognito Identity Provider using the specified AWS account credentials provider and client configuration options.AWSCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on Amazon Cognito Identity Provider using the specified AWS account credentials provider, client configuration options, and request metric collector.AWSCognitoIdentityProviderClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon Cognito Identity Provider using the specified AWS account credentials and client configuration options.AWSCognitoIdentityProviderClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon Cognito Identity Provider.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.SetUserSettingsResult
setUserSettings(SetUserSettingsRequest setUserSettingsRequest)
Sets the user settings like multi-factor authentication (MFA).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.-
Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeMarshalling, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.amazonaws.services.cognitoidp.AWSCognitoIdentityProvider
setEndpoint, setRegion, shutdown
-
-
-
-
Field Detail
-
configFactory
protected static final ClientConfigurationFactory configFactory
Client configuration factory providing ClientConfigurations tailored to this client
-
-
Constructor Detail
-
AWSCognitoIdentityProviderClient
public AWSCognitoIdentityProviderClient()
Constructs a new client to invoke service methods on Amazon Cognito Identity Provider. A credentials provider chain will be used that searches for credentials in this order:- Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
- Java System Properties - aws.accessKeyId and aws.secretKey
- Instance profile credentials delivered through the Amazon EC2 metadata service
All service calls made using this new client object are blocking, and will not return until the service call completes.
- See Also:
DefaultAWSCredentialsProviderChain
-
AWSCognitoIdentityProviderClient
public AWSCognitoIdentityProviderClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon Cognito Identity Provider. A credentials provider chain will be used that searches for credentials in this order:- Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
- Java System Properties - aws.accessKeyId and aws.secretKey
- Instance profile credentials delivered through the Amazon EC2 metadata service
All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
clientConfiguration
- The client configuration options controlling how this client connects to Amazon Cognito Identity Provider (ex: proxy settings, retry counts, etc.).- See Also:
DefaultAWSCredentialsProviderChain
-
AWSCognitoIdentityProviderClient
public AWSCognitoIdentityProviderClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on Amazon Cognito Identity Provider using the specified AWS account credentials.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
-
AWSCognitoIdentityProviderClient
public AWSCognitoIdentityProviderClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon Cognito Identity Provider using the specified AWS account credentials and client configuration options.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon Cognito Identity Provider (ex: proxy settings, retry counts, etc.).
-
AWSCognitoIdentityProviderClient
public AWSCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on Amazon Cognito Identity Provider using the specified AWS account credentials provider.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
-
AWSCognitoIdentityProviderClient
public AWSCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon Cognito Identity Provider using the specified AWS account credentials provider and client configuration options.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon Cognito Identity Provider (ex: proxy settings, retry counts, etc.).
-
AWSCognitoIdentityProviderClient
public AWSCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on Amazon Cognito Identity Provider using the specified AWS account credentials provider, client configuration options, and request metric collector.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon Cognito Identity Provider (ex: proxy settings, retry counts, etc.).requestMetricCollector
- optional request metric collector
-
-
Method Detail
-
addCustomAttributes
public AddCustomAttributesResult addCustomAttributes(AddCustomAttributesRequest addCustomAttributesRequest)
Adds additional user attributes to the user pool schema.
- Specified by:
addCustomAttributes
in interfaceAWSCognitoIdentityProvider
- 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
public AdminConfirmSignUpResult adminConfirmSignUp(AdminConfirmSignUpRequest adminConfirmSignUpRequest)
Confirms user registration as an admin without using a confirmation code. Works on any user.
- Specified by:
adminConfirmSignUp
in interfaceAWSCognitoIdentityProvider
- 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
public AdminDeleteUserResult adminDeleteUser(AdminDeleteUserRequest adminDeleteUserRequest)
Deletes a user as an administrator. Works on any user.
- Specified by:
adminDeleteUser
in interfaceAWSCognitoIdentityProvider
- 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
public AdminDeleteUserAttributesResult adminDeleteUserAttributes(AdminDeleteUserAttributesRequest adminDeleteUserAttributesRequest)
Deletes the user attributes in a user pool as an administrator. Works on any user.
- Specified by:
adminDeleteUserAttributes
in interfaceAWSCognitoIdentityProvider
- 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
public AdminDisableUserResult adminDisableUser(AdminDisableUserRequest adminDisableUserRequest)
Disables the specified user as an administrator. Works on any user.
- Specified by:
adminDisableUser
in interfaceAWSCognitoIdentityProvider
- 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
public AdminEnableUserResult adminEnableUser(AdminEnableUserRequest adminEnableUserRequest)
Enables the specified user as an administrator. Works on any user.
- Specified by:
adminEnableUser
in interfaceAWSCognitoIdentityProvider
- 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
public AdminGetUserResult adminGetUser(AdminGetUserRequest adminGetUserRequest)
Gets the specified user by user name in a user pool as an administrator. Works on any user.
- Specified by:
adminGetUser
in interfaceAWSCognitoIdentityProvider
- 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
public AdminResetUserPasswordResult adminResetUserPassword(AdminResetUserPasswordRequest adminResetUserPasswordRequest)
Resets the specified user's password in a user pool as an administrator. Works on any user.
- Specified by:
adminResetUserPassword
in interfaceAWSCognitoIdentityProvider
- 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
public AdminSetUserSettingsResult adminSetUserSettings(AdminSetUserSettingsRequest adminSetUserSettingsRequest)
Sets all the user settings for a specified user name. Works on any user.
- Specified by:
adminSetUserSettings
in interfaceAWSCognitoIdentityProvider
- 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
public AdminUpdateUserAttributesResult adminUpdateUserAttributes(AdminUpdateUserAttributesRequest adminUpdateUserAttributesRequest)
Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.
- Specified by:
adminUpdateUserAttributes
in interfaceAWSCognitoIdentityProvider
- 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
public ChangePasswordResult changePassword(ChangePasswordRequest changePasswordRequest)
Changes the password for a specified user in a user pool.
- Specified by:
changePassword
in interfaceAWSCognitoIdentityProvider
- 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
public ConfirmForgotPasswordResult confirmForgotPassword(ConfirmForgotPasswordRequest confirmForgotPasswordRequest)
Allows a user to enter a code provided when they reset their password to update their password.
- Specified by:
confirmForgotPassword
in interfaceAWSCognitoIdentityProvider
- 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
public ConfirmSignUpResult confirmSignUp(ConfirmSignUpRequest confirmSignUpRequest)
Confirms registration of a user and handles the existing alias from a previous user.
- Specified by:
confirmSignUp
in interfaceAWSCognitoIdentityProvider
- 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
public CreateUserPoolResult createUserPool(CreateUserPoolRequest createUserPoolRequest)
Creates a new Amazon Cognito user pool and sets the password policy for the pool.
- Specified by:
createUserPool
in interfaceAWSCognitoIdentityProvider
- 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
public CreateUserPoolClientResult createUserPoolClient(CreateUserPoolClientRequest createUserPoolClientRequest)
Creates the user pool client.
- Specified by:
createUserPoolClient
in interfaceAWSCognitoIdentityProvider
- 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
public DeleteUserResult deleteUser(DeleteUserRequest deleteUserRequest)
Allows a user to delete one's self.
- Specified by:
deleteUser
in interfaceAWSCognitoIdentityProvider
- 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
public DeleteUserAttributesResult deleteUserAttributes(DeleteUserAttributesRequest deleteUserAttributesRequest)
Deletes the attributes for a user.
- Specified by:
deleteUserAttributes
in interfaceAWSCognitoIdentityProvider
- 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
public DeleteUserPoolResult deleteUserPool(DeleteUserPoolRequest deleteUserPoolRequest)
Deletes the specified Amazon Cognito user pool.
- Specified by:
deleteUserPool
in interfaceAWSCognitoIdentityProvider
- 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
public DeleteUserPoolClientResult deleteUserPoolClient(DeleteUserPoolClientRequest deleteUserPoolClientRequest)
Allows the developer to delete the user pool client.
- Specified by:
deleteUserPoolClient
in interfaceAWSCognitoIdentityProvider
- 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
public DescribeUserPoolResult describeUserPool(DescribeUserPoolRequest describeUserPoolRequest)
Returns the configuration information and metadata of the specified user pool.
- Specified by:
describeUserPool
in interfaceAWSCognitoIdentityProvider
- 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
public DescribeUserPoolClientResult describeUserPoolClient(DescribeUserPoolClientRequest describeUserPoolClientRequest)
Client method for returning the configuration information and metadata of the specified user pool client.
- Specified by:
describeUserPoolClient
in interfaceAWSCognitoIdentityProvider
- 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
public ForgotPasswordResult forgotPassword(ForgotPasswordRequest forgotPasswordRequest)
Retrieves the password for the specified client ID or username.
- Specified by:
forgotPassword
in interfaceAWSCognitoIdentityProvider
- 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
public GetUserResult getUser(GetUserRequest getUserRequest)
Gets the user attributes and metadata for a user.
- Specified by:
getUser
in interfaceAWSCognitoIdentityProvider
- 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
public GetUserAttributeVerificationCodeResult getUserAttributeVerificationCode(GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest)
Gets the user attribute verification code for the specified attribute name.
- Specified by:
getUserAttributeVerificationCode
in interfaceAWSCognitoIdentityProvider
- 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
public ListUserPoolClientsResult listUserPoolClients(ListUserPoolClientsRequest listUserPoolClientsRequest)
Lists the clients that have been created for the specified user pool.
- Specified by:
listUserPoolClients
in interfaceAWSCognitoIdentityProvider
- 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
public ListUserPoolsResult listUserPools(ListUserPoolsRequest listUserPoolsRequest)
Lists the user pools associated with an AWS account.
- Specified by:
listUserPools
in interfaceAWSCognitoIdentityProvider
- 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
public ListUsersResult listUsers(ListUsersRequest listUsersRequest)
Lists the users in the Amazon Cognito user pool.
- Specified by:
listUsers
in interfaceAWSCognitoIdentityProvider
- 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
public ResendConfirmationCodeResult resendConfirmationCode(ResendConfirmationCodeRequest resendConfirmationCodeRequest)
Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
- Specified by:
resendConfirmationCode
in interfaceAWSCognitoIdentityProvider
- 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
public 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.
- Specified by:
setUserSettings
in interfaceAWSCognitoIdentityProvider
- 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
public SignUpResult signUp(SignUpRequest signUpRequest)
Registers the user in the specified user pool and creates a user name, password, and user attributes.
- Specified by:
signUp
in interfaceAWSCognitoIdentityProvider
- 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
public UpdateUserAttributesResult updateUserAttributes(UpdateUserAttributesRequest updateUserAttributesRequest)
Allows a user to update a specific attribute (one at a time).
- Specified by:
updateUserAttributes
in interfaceAWSCognitoIdentityProvider
- 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
public UpdateUserPoolResult updateUserPool(UpdateUserPoolRequest updateUserPoolRequest)
Updates the specified user pool with the specified attributes.
- Specified by:
updateUserPool
in interfaceAWSCognitoIdentityProvider
- 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
public UpdateUserPoolClientResult updateUserPoolClient(UpdateUserPoolClientRequest updateUserPoolClientRequest)
Allows the developer to update the specified user pool client and password policy.
- Specified by:
updateUserPoolClient
in interfaceAWSCognitoIdentityProvider
- 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
public VerifyUserAttributeResult verifyUserAttribute(VerifyUserAttributeRequest verifyUserAttributeRequest)
Verifies the specified user attributes in the user pool.
- Specified by:
verifyUserAttribute
in interfaceAWSCognitoIdentityProvider
- 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.
-
getCachedResponseMetadata
public 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 the request.
- Specified by:
getCachedResponseMetadata
in interfaceAWSCognitoIdentityProvider
- Parameters:
request
- The originally executed request- Returns:
- The response metadata for the specified request, or null if none is available.
-
-