Class AbstractAWSCognitoIdentityProvider
- All Implemented Interfaces:
AWSCognitoIdentityProvider
- Direct Known Subclasses:
AbstractAWSCognitoIdentityProviderAsync
AWSCognitoIdentityProvider
. Convenient
method forms pass through to the corresponding overload that takes a request
object, which throws an UnsupportedOperationException
.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionAdds additional user attributes to the user pool schema.Confirms user registration as an admin without using a confirmation code.adminDeleteUser
(AdminDeleteUserRequest request) Deletes a user as an administrator.Deletes the user attributes in a user pool as an administrator.adminDisableUser
(AdminDisableUserRequest request) Disables the specified user as an administrator.adminEnableUser
(AdminEnableUserRequest request) Enables the specified user as an administrator.adminGetUser
(AdminGetUserRequest request) Gets the specified user by user name in a user pool as an administrator.Resets the specified user's password in a user pool as an administrator.Sets all the user settings for a specified user name.Updates the specified user's attributes, including developer attributes, as an administrator.changePassword
(ChangePasswordRequest request) Changes the password for a specified user in a user pool.Allows a user to enter a code provided when they reset their password to update their password.confirmSignUp
(ConfirmSignUpRequest request) Confirms registration of a user and handles the existing alias from a previous user.createUserPool
(CreateUserPoolRequest request) Creates a new Amazon Cognito user pool and sets the password policy for the pool.Creates the user pool client.deleteUser
(DeleteUserRequest request) Allows a user to delete one's self.Deletes the attributes for a user.deleteUserPool
(DeleteUserPoolRequest request) Deletes the specified Amazon Cognito user pool.Allows the developer to delete the user pool client.describeUserPool
(DescribeUserPoolRequest request) Returns the configuration information and metadata of the specified user pool.Client method for returning the configuration information and metadata of the specified user pool client.forgotPassword
(ForgotPasswordRequest request) Retrieves the password for the specified client ID or username.Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.getUser
(GetUserRequest request) Gets the user attributes and metadata for a user.Gets the user attribute verification code for the specified attribute name.Lists the clients that have been created for the specified user pool.listUserPools
(ListUserPoolsRequest request) Lists the user pools associated with an AWS account.listUsers
(ListUsersRequest request) Lists the users in the Amazon Cognito user pool.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
An alternative toAWSCognitoIdentityProvider.setEndpoint(String)
, sets the regional endpoint for this client's service calls.setUserSettings
(SetUserSettingsRequest request) Sets the user settings like multi-factor authentication (MFA).void
shutdown()
Shuts down this client object, releasing any resources that might be held open.signUp
(SignUpRequest request) Registers the user in the specified user pool and creates a user name, password, and user attributes.Allows a user to update a specific attribute (one at a time).updateUserPool
(UpdateUserPoolRequest request) Updates the specified user pool with the specified attributes.Allows the developer to update the specified user pool client and password policy.Verifies the specified user attributes in the user pool.
-
Constructor Details
-
AbstractAWSCognitoIdentityProvider
protected AbstractAWSCognitoIdentityProvider()
-
-
Method Details
-
setEndpoint
Description copied from interface:AWSCognitoIdentityProvider
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.
- Specified by:
setEndpoint
in interfaceAWSCognitoIdentityProvider
- 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
Description copied from interface:AWSCognitoIdentityProvider
An alternative toAWSCognitoIdentityProvider.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.
- Specified by:
setRegion
in interfaceAWSCognitoIdentityProvider
- Parameters:
region
- The region this client will communicate with. SeeRegion.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:
-
addCustomAttributes
Description copied from interface:AWSCognitoIdentityProvider
Adds additional user attributes to the user pool schema.
- Specified by:
addCustomAttributes
in interfaceAWSCognitoIdentityProvider
- Parameters:
request
- Represents the request to add custom attributes.- Returns:
- Result of the AddCustomAttributes operation returned by the service.
-
adminConfirmSignUp
Description copied from interface:AWSCognitoIdentityProvider
Confirms user registration as an admin without using a confirmation code. Works on any user.
- Specified by:
adminConfirmSignUp
in interfaceAWSCognitoIdentityProvider
- Parameters:
request
- Represents the request to confirm user registration.- Returns:
- Result of the AdminConfirmSignUp operation returned by the service.
-
adminDeleteUser
Description copied from interface:AWSCognitoIdentityProvider
Deletes a user as an administrator. Works on any user.
- Specified by:
adminDeleteUser
in interfaceAWSCognitoIdentityProvider
- Parameters:
request
- Represents the request to delete a user as an administrator.- Returns:
- Result of the AdminDeleteUser operation returned by the service.
-
adminDeleteUserAttributes
public AdminDeleteUserAttributesResult adminDeleteUserAttributes(AdminDeleteUserAttributesRequest request) Description copied from interface:AWSCognitoIdentityProvider
Deletes the user attributes in a user pool as an administrator. Works on any user.
- Specified by:
adminDeleteUserAttributes
in interfaceAWSCognitoIdentityProvider
- Parameters:
request
- Represents the request to delete user attributes as an administrator.- Returns:
- Result of the AdminDeleteUserAttributes operation returned by the service.
-
adminDisableUser
Description copied from interface:AWSCognitoIdentityProvider
Disables the specified user as an administrator. Works on any user.
- Specified by:
adminDisableUser
in interfaceAWSCognitoIdentityProvider
- Parameters:
request
- Represents the request to disable any user as an administrator.- Returns:
- Result of the AdminDisableUser operation returned by the service.
-
adminEnableUser
Description copied from interface:AWSCognitoIdentityProvider
Enables the specified user as an administrator. Works on any user.
- Specified by:
adminEnableUser
in interfaceAWSCognitoIdentityProvider
- Parameters:
request
- Represents the request that enables the user as an administrator.- Returns:
- Result of the AdminEnableUser operation returned by the service.
-
adminGetUser
Description copied from interface:AWSCognitoIdentityProvider
Gets the specified user by user name in a user pool as an administrator. Works on any user.
- Specified by:
adminGetUser
in interfaceAWSCognitoIdentityProvider
- Parameters:
request
- Represents the request to get the specified user as an administrator.- Returns:
- Result of the AdminGetUser operation returned by the service.
-
adminResetUserPassword
Description copied from interface:AWSCognitoIdentityProvider
Resets the specified user's password in a user pool as an administrator. Works on any user.
- Specified by:
adminResetUserPassword
in interfaceAWSCognitoIdentityProvider
- Parameters:
request
- Represents the request to reset a user's password as an administrator.- Returns:
- Result of the AdminResetUserPassword operation returned by the service.
-
adminSetUserSettings
Description copied from interface:AWSCognitoIdentityProvider
Sets all the user settings for a specified user name. Works on any user.
- Specified by:
adminSetUserSettings
in interfaceAWSCognitoIdentityProvider
- Parameters:
request
- Represents the request to set user settings as an administrator.- Returns:
- Result of the AdminSetUserSettings operation returned by the service.
-
adminUpdateUserAttributes
public AdminUpdateUserAttributesResult adminUpdateUserAttributes(AdminUpdateUserAttributesRequest request) Description copied from interface:AWSCognitoIdentityProvider
Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.
- Specified by:
adminUpdateUserAttributes
in interfaceAWSCognitoIdentityProvider
- Parameters:
request
- Represents the request to update the user's attributes as an administrator.- Returns:
- Result of the AdminUpdateUserAttributes operation returned by the service.
-
changePassword
Description copied from interface:AWSCognitoIdentityProvider
Changes the password for a specified user in a user pool.
- Specified by:
changePassword
in interfaceAWSCognitoIdentityProvider
- Parameters:
request
- Represents the request to change a user password.- Returns:
- Result of the ChangePassword operation returned by the service.
-
confirmForgotPassword
Description copied from interface:AWSCognitoIdentityProvider
Allows a user to enter a code provided when they reset their password to update their password.
- Specified by:
confirmForgotPassword
in interfaceAWSCognitoIdentityProvider
- Parameters:
request
- The request representing the confirmation for a password reset.- Returns:
- Result of the ConfirmForgotPassword operation returned by the service.
-
confirmSignUp
Description copied from interface:AWSCognitoIdentityProvider
Confirms registration of a user and handles the existing alias from a previous user.
- Specified by:
confirmSignUp
in interfaceAWSCognitoIdentityProvider
- Parameters:
request
- Represents the request to confirm registration of a user.- Returns:
- Result of the ConfirmSignUp operation returned by the service.
-
createUserPool
Description copied from interface:AWSCognitoIdentityProvider
Creates a new Amazon Cognito user pool and sets the password policy for the pool.
- Specified by:
createUserPool
in interfaceAWSCognitoIdentityProvider
- Parameters:
request
- Represents the request to create a user pool.- Returns:
- Result of the CreateUserPool operation returned by the service.
-
createUserPoolClient
Description copied from interface:AWSCognitoIdentityProvider
Creates the user pool client.
- Specified by:
createUserPoolClient
in interfaceAWSCognitoIdentityProvider
- Parameters:
request
- Represents the request to create a user pool client.- Returns:
- Result of the CreateUserPoolClient operation returned by the service.
-
deleteUser
Description copied from interface:AWSCognitoIdentityProvider
Allows a user to delete one's self.
- Specified by:
deleteUser
in interfaceAWSCognitoIdentityProvider
- Parameters:
request
- Represents the request to delete a user.- Returns:
- Result of the DeleteUser operation returned by the service.
-
deleteUserAttributes
Description copied from interface:AWSCognitoIdentityProvider
Deletes the attributes for a user.
- Specified by:
deleteUserAttributes
in interfaceAWSCognitoIdentityProvider
- Parameters:
request
- Represents the request to delete user attributes.- Returns:
- Result of the DeleteUserAttributes operation returned by the service.
-
deleteUserPool
Description copied from interface:AWSCognitoIdentityProvider
Deletes the specified Amazon Cognito user pool.
- Specified by:
deleteUserPool
in interfaceAWSCognitoIdentityProvider
- Parameters:
request
- Represents the request to delete a user pool.- Returns:
- Result of the DeleteUserPool operation returned by the service.
-
deleteUserPoolClient
Description copied from interface:AWSCognitoIdentityProvider
Allows the developer to delete the user pool client.
- Specified by:
deleteUserPoolClient
in interfaceAWSCognitoIdentityProvider
- Parameters:
request
- Represents the request to delete a user pool client.- Returns:
- Result of the DeleteUserPoolClient operation returned by the service.
-
describeUserPool
Description copied from interface:AWSCognitoIdentityProvider
Returns the configuration information and metadata of the specified user pool.
- Specified by:
describeUserPool
in interfaceAWSCognitoIdentityProvider
- Parameters:
request
- Represents the request to describe the user pool.- Returns:
- Result of the DescribeUserPool operation returned by the service.
-
describeUserPoolClient
Description copied from interface:AWSCognitoIdentityProvider
Client method for returning the configuration information and metadata of the specified user pool client.
- Specified by:
describeUserPoolClient
in interfaceAWSCognitoIdentityProvider
- Parameters:
request
- Represents the request to describe a user pool client.- Returns:
- Result of the DescribeUserPoolClient operation returned by the service.
-
forgotPassword
Description copied from interface:AWSCognitoIdentityProvider
Retrieves the password for the specified client ID or username.
- Specified by:
forgotPassword
in interfaceAWSCognitoIdentityProvider
- Parameters:
request
- Represents the request to reset a user's password.- Returns:
- Result of the ForgotPassword operation returned by the service.
-
getUser
Description copied from interface:AWSCognitoIdentityProvider
Gets the user attributes and metadata for a user.
- Specified by:
getUser
in interfaceAWSCognitoIdentityProvider
- Parameters:
request
- Represents the request to get information about the user.- Returns:
- Result of the GetUser operation returned by the service.
-
getUserAttributeVerificationCode
public GetUserAttributeVerificationCodeResult getUserAttributeVerificationCode(GetUserAttributeVerificationCodeRequest request) Description copied from interface:AWSCognitoIdentityProvider
Gets the user attribute verification code for the specified attribute name.
- Specified by:
getUserAttributeVerificationCode
in interfaceAWSCognitoIdentityProvider
- Parameters:
request
- Represents the request to get user attribute verification.- Returns:
- Result of the GetUserAttributeVerificationCode operation returned by the service.
-
listUserPoolClients
Description copied from interface:AWSCognitoIdentityProvider
Lists the clients that have been created for the specified user pool.
- Specified by:
listUserPoolClients
in interfaceAWSCognitoIdentityProvider
- Parameters:
request
- Represents the request to list the user pool clients.- Returns:
- Result of the ListUserPoolClients operation returned by the service.
-
listUserPools
Description copied from interface:AWSCognitoIdentityProvider
Lists the user pools associated with an AWS account.
- Specified by:
listUserPools
in interfaceAWSCognitoIdentityProvider
- Parameters:
request
- Represents the request to list user pools.- Returns:
- Result of the ListUserPools operation returned by the service.
-
listUsers
Description copied from interface:AWSCognitoIdentityProvider
Lists the users in the Amazon Cognito user pool.
- Specified by:
listUsers
in interfaceAWSCognitoIdentityProvider
- Parameters:
request
- Represents the request to list users.- Returns:
- Result of the ListUsers operation returned by the service.
-
resendConfirmationCode
Description copied from interface:AWSCognitoIdentityProvider
Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
- Specified by:
resendConfirmationCode
in interfaceAWSCognitoIdentityProvider
- Parameters:
request
- Represents the request to resend the confirmation code.- Returns:
- Result of the ResendConfirmationCode operation returned by the service.
-
setUserSettings
Description copied from interface:AWSCognitoIdentityProvider
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:
request
- Represents the request to set user settings.- Returns:
- Result of the SetUserSettings operation returned by the service.
-
signUp
Description copied from interface:AWSCognitoIdentityProvider
Registers the user in the specified user pool and creates a user name, password, and user attributes.
- Specified by:
signUp
in interfaceAWSCognitoIdentityProvider
- Parameters:
request
- Represents the request to register a user.- Returns:
- Result of the SignUp operation returned by the service.
-
updateUserAttributes
Description copied from interface:AWSCognitoIdentityProvider
Allows a user to update a specific attribute (one at a time).
- Specified by:
updateUserAttributes
in interfaceAWSCognitoIdentityProvider
- Parameters:
request
- Represents the request to update user attributes.- Returns:
- Result of the UpdateUserAttributes operation returned by the service.
-
updateUserPool
Description copied from interface:AWSCognitoIdentityProvider
Updates the specified user pool with the specified attributes.
- Specified by:
updateUserPool
in interfaceAWSCognitoIdentityProvider
- Parameters:
request
- Represents the request to update the user pool.- Returns:
- Result of the UpdateUserPool operation returned by the service.
-
updateUserPoolClient
Description copied from interface:AWSCognitoIdentityProvider
Allows the developer to update the specified user pool client and password policy.
- Specified by:
updateUserPoolClient
in interfaceAWSCognitoIdentityProvider
- Parameters:
request
- Represents the request to update the user pool client.- Returns:
- Result of the UpdateUserPoolClient operation returned by the service.
-
verifyUserAttribute
Description copied from interface:AWSCognitoIdentityProvider
Verifies the specified user attributes in the user pool.
- Specified by:
verifyUserAttribute
in interfaceAWSCognitoIdentityProvider
- Parameters:
request
- Represents the request to verify user attributes.- Returns:
- Result of the VerifyUserAttribute operation returned by the service.
-
shutdown
public void shutdown()Description copied from interface:AWSCognitoIdentityProvider
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.- Specified by:
shutdown
in interfaceAWSCognitoIdentityProvider
-
getCachedResponseMetadata
Description copied from interface:AWSCognitoIdentityProvider
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.
- 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.
-