AutoCloseable
@Generated("software.amazon.awssdk:codegen") public interface CognitoIdentityProviderClient extends AutoCloseable
builder()
method.
Using the Amazon Cognito User Pools API, you can create a user pool to manage directories and users. You can authenticate a user to obtain tokens related to user identity and access policies.
This API reference provides information about user pools in Amazon Cognito User Pools.
For more information, see the Amazon Cognito Documentation.
Modifier and Type | Field | Description |
---|---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method | Description |
---|---|---|
default AddCustomAttributesResponse |
addCustomAttributes(AddCustomAttributesRequest addCustomAttributesRequest) |
Adds additional user attributes to the user pool schema.
|
default AdminAddUserToGroupResponse |
adminAddUserToGroup(AdminAddUserToGroupRequest adminAddUserToGroupRequest) |
Adds the specified user to the specified group.
|
default AdminConfirmSignUpResponse |
adminConfirmSignUp(AdminConfirmSignUpRequest adminConfirmSignUpRequest) |
Confirms user registration as an admin without using a confirmation code.
|
default AdminCreateUserResponse |
adminCreateUser(AdminCreateUserRequest adminCreateUserRequest) |
Creates a new user in the specified user pool and sends a welcome message via email or phone (SMS).
|
default AdminDeleteUserResponse |
adminDeleteUser(AdminDeleteUserRequest adminDeleteUserRequest) |
Deletes a user as an administrator.
|
default AdminDeleteUserAttributesResponse |
adminDeleteUserAttributes(AdminDeleteUserAttributesRequest adminDeleteUserAttributesRequest) |
Deletes the user attributes in a user pool as an administrator.
|
default AdminDisableUserResponse |
adminDisableUser(AdminDisableUserRequest adminDisableUserRequest) |
Disables the specified user as an administrator.
|
default AdminEnableUserResponse |
adminEnableUser(AdminEnableUserRequest adminEnableUserRequest) |
Enables the specified user as an administrator.
|
default AdminForgetDeviceResponse |
adminForgetDevice(AdminForgetDeviceRequest adminForgetDeviceRequest) |
Forgets the device, as an administrator.
|
default AdminGetDeviceResponse |
adminGetDevice(AdminGetDeviceRequest adminGetDeviceRequest) |
Gets the device, as an administrator.
|
default AdminGetUserResponse |
adminGetUser(AdminGetUserRequest adminGetUserRequest) |
Gets the specified user by user name in a user pool as an administrator.
|
default AdminInitiateAuthResponse |
adminInitiateAuth(AdminInitiateAuthRequest adminInitiateAuthRequest) |
Initiates the authentication flow, as an administrator.
|
default AdminListDevicesResponse |
adminListDevices(AdminListDevicesRequest adminListDevicesRequest) |
Lists devices, as an administrator.
|
default AdminListGroupsForUserResponse |
adminListGroupsForUser(AdminListGroupsForUserRequest adminListGroupsForUserRequest) |
Lists the groups that the user belongs to.
|
default AdminRemoveUserFromGroupResponse |
adminRemoveUserFromGroup(AdminRemoveUserFromGroupRequest adminRemoveUserFromGroupRequest) |
Removes the specified user from the specified group.
|
default AdminResetUserPasswordResponse |
adminResetUserPassword(AdminResetUserPasswordRequest adminResetUserPasswordRequest) |
Resets the specified user's password in a user pool as an administrator.
|
default AdminRespondToAuthChallengeResponse |
adminRespondToAuthChallenge(AdminRespondToAuthChallengeRequest adminRespondToAuthChallengeRequest) |
Responds to an authentication challenge, as an administrator.
|
default AdminSetUserSettingsResponse |
adminSetUserSettings(AdminSetUserSettingsRequest adminSetUserSettingsRequest) |
Sets all the user settings for a specified user name.
|
default AdminUpdateDeviceStatusResponse |
adminUpdateDeviceStatus(AdminUpdateDeviceStatusRequest adminUpdateDeviceStatusRequest) |
Updates the device status as an administrator.
|
default AdminUpdateUserAttributesResponse |
adminUpdateUserAttributes(AdminUpdateUserAttributesRequest adminUpdateUserAttributesRequest) |
Updates the specified user's attributes, including developer attributes, as an administrator.
|
default AdminUserGlobalSignOutResponse |
adminUserGlobalSignOut(AdminUserGlobalSignOutRequest adminUserGlobalSignOutRequest) |
Signs out users from all devices, as an administrator.
|
static CognitoIdentityProviderClientBuilder |
builder() |
Create a builder that can be used to configure and create a
CognitoIdentityProviderClient . |
default ChangePasswordResponse |
changePassword(ChangePasswordRequest changePasswordRequest) |
Changes the password for a specified user in a user pool.
|
default ConfirmDeviceResponse |
confirmDevice(ConfirmDeviceRequest confirmDeviceRequest) |
Confirms tracking of the device.
|
default ConfirmForgotPasswordResponse |
confirmForgotPassword(ConfirmForgotPasswordRequest confirmForgotPasswordRequest) |
Allows a user to enter a confirmation code to reset a forgotten password.
|
default ConfirmSignUpResponse |
confirmSignUp(ConfirmSignUpRequest confirmSignUpRequest) |
Confirms registration of a user and handles the existing alias from a previous user.
|
static CognitoIdentityProviderClient |
create() |
Create a
CognitoIdentityProviderClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateGroupResponse |
createGroup(CreateGroupRequest createGroupRequest) |
Creates a new group in the specified user pool.
|
default CreateIdentityProviderResponse |
createIdentityProvider(CreateIdentityProviderRequest createIdentityProviderRequest) |
Creates an identity provider for a user pool.
|
default CreateUserImportJobResponse |
createUserImportJob(CreateUserImportJobRequest createUserImportJobRequest) |
Creates the user import job.
|
default CreateUserPoolResponse |
createUserPool(CreateUserPoolRequest createUserPoolRequest) |
Creates a new Amazon Cognito user pool and sets the password policy for the pool.
|
default CreateUserPoolClientResponse |
createUserPoolClient(CreateUserPoolClientRequest createUserPoolClientRequest) |
Creates the user pool client.
|
default CreateUserPoolDomainResponse |
createUserPoolDomain(CreateUserPoolDomainRequest createUserPoolDomainRequest) |
Creates a new domain for a user pool.
|
default DeleteGroupResponse |
deleteGroup(DeleteGroupRequest deleteGroupRequest) |
Deletes a group.
|
default DeleteIdentityProviderResponse |
deleteIdentityProvider(DeleteIdentityProviderRequest deleteIdentityProviderRequest) |
Deletes an identity provider for a user pool.
|
default DeleteUserResponse |
deleteUser(DeleteUserRequest deleteUserRequest) |
Allows a user to delete one's self.
|
default DeleteUserAttributesResponse |
deleteUserAttributes(DeleteUserAttributesRequest deleteUserAttributesRequest) |
Deletes the attributes for a user.
|
default DeleteUserPoolResponse |
deleteUserPool(DeleteUserPoolRequest deleteUserPoolRequest) |
Deletes the specified Amazon Cognito user pool.
|
default DeleteUserPoolClientResponse |
deleteUserPoolClient(DeleteUserPoolClientRequest deleteUserPoolClientRequest) |
Allows the developer to delete the user pool client.
|
default DeleteUserPoolDomainResponse |
deleteUserPoolDomain(DeleteUserPoolDomainRequest deleteUserPoolDomainRequest) |
Deletes a domain for a user pool.
|
default DescribeIdentityProviderResponse |
describeIdentityProvider(DescribeIdentityProviderRequest describeIdentityProviderRequest) |
Gets information about a specific identity provider.
|
default DescribeUserImportJobResponse |
describeUserImportJob(DescribeUserImportJobRequest describeUserImportJobRequest) |
Describes the user import job.
|
default DescribeUserPoolResponse |
describeUserPool(DescribeUserPoolRequest describeUserPoolRequest) |
Returns the configuration information and metadata of the specified user pool.
|
default DescribeUserPoolClientResponse |
describeUserPoolClient(DescribeUserPoolClientRequest describeUserPoolClientRequest) |
Client method for returning the configuration information and metadata of the specified user pool client.
|
default DescribeUserPoolDomainResponse |
describeUserPoolDomain(DescribeUserPoolDomainRequest describeUserPoolDomainRequest) |
Gets information about a domain.
|
default ForgetDeviceResponse |
forgetDevice(ForgetDeviceRequest forgetDeviceRequest) |
Forgets the specified device.
|
default ForgotPasswordResponse |
forgotPassword(ForgotPasswordRequest forgotPasswordRequest) |
Calling this API causes a message to be sent to the end user with a confirmation code that is required to change
the user's password.
|
default GetCSVHeaderResponse |
getCSVHeader(GetCSVHeaderRequest getCSVHeaderRequest) |
Gets the header information for the .csv file to be used as input for the user import job.
|
default GetDeviceResponse |
getDevice(GetDeviceRequest getDeviceRequest) |
Gets the device.
|
default GetGroupResponse |
getGroup(GetGroupRequest getGroupRequest) |
Gets a group.
|
default GetIdentityProviderByIdentifierResponse |
getIdentityProviderByIdentifier(GetIdentityProviderByIdentifierRequest getIdentityProviderByIdentifierRequest) |
Gets the specified identity provider.
|
default GetUserResponse |
getUser(GetUserRequest getUserRequest) |
Gets the user attributes and metadata for a user.
|
default GetUserAttributeVerificationCodeResponse |
getUserAttributeVerificationCode(GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest) |
Gets the user attribute verification code for the specified attribute name.
|
default GlobalSignOutResponse |
globalSignOut(GlobalSignOutRequest globalSignOutRequest) |
Signs out users from all devices.
|
default InitiateAuthResponse |
initiateAuth(InitiateAuthRequest initiateAuthRequest) |
Initiates the authentication flow.
|
default ListDevicesResponse |
listDevices(ListDevicesRequest listDevicesRequest) |
Lists the devices.
|
default ListGroupsResponse |
listGroups(ListGroupsRequest listGroupsRequest) |
Lists the groups associated with a user pool.
|
default ListIdentityProvidersResponse |
listIdentityProviders(ListIdentityProvidersRequest listIdentityProvidersRequest) |
Lists information about all identity providers for a user pool.
|
default ListUserImportJobsResponse |
listUserImportJobs(ListUserImportJobsRequest listUserImportJobsRequest) |
Lists the user import jobs.
|
default ListUserPoolClientsResponse |
listUserPoolClients(ListUserPoolClientsRequest listUserPoolClientsRequest) |
Lists the clients that have been created for the specified user pool.
|
default ListUserPoolsResponse |
listUserPools(ListUserPoolsRequest listUserPoolsRequest) |
Lists the user pools associated with an AWS account.
|
default ListUsersResponse |
listUsers(ListUsersRequest listUsersRequest) |
Lists the users in the Amazon Cognito user pool.
|
default ListUsersInGroupResponse |
listUsersInGroup(ListUsersInGroupRequest listUsersInGroupRequest) |
Lists the users in the specified group.
|
default ResendConfirmationCodeResponse |
resendConfirmationCode(ResendConfirmationCodeRequest resendConfirmationCodeRequest) |
Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
|
default RespondToAuthChallengeResponse |
respondToAuthChallenge(RespondToAuthChallengeRequest respondToAuthChallengeRequest) |
Responds to the authentication challenge.
|
static ServiceMetadata |
serviceMetadata() |
|
default SetUserSettingsResponse |
setUserSettings(SetUserSettingsRequest setUserSettingsRequest) |
Sets the user settings like multi-factor authentication (MFA).
|
default SignUpResponse |
signUp(SignUpRequest signUpRequest) |
Registers the user in the specified user pool and creates a user name, password, and user attributes.
|
default StartUserImportJobResponse |
startUserImportJob(StartUserImportJobRequest startUserImportJobRequest) |
Starts the user import.
|
default StopUserImportJobResponse |
stopUserImportJob(StopUserImportJobRequest stopUserImportJobRequest) |
Stops the user import job.
|
default UpdateDeviceStatusResponse |
updateDeviceStatus(UpdateDeviceStatusRequest updateDeviceStatusRequest) |
Updates the device status.
|
default UpdateGroupResponse |
updateGroup(UpdateGroupRequest updateGroupRequest) |
Updates the specified group with the specified attributes.
|
default UpdateIdentityProviderResponse |
updateIdentityProvider(UpdateIdentityProviderRequest updateIdentityProviderRequest) |
Updates identity provider information for a user pool.
|
default UpdateUserAttributesResponse |
updateUserAttributes(UpdateUserAttributesRequest updateUserAttributesRequest) |
Allows a user to update a specific attribute (one at a time).
|
default UpdateUserPoolResponse |
updateUserPool(UpdateUserPoolRequest updateUserPoolRequest) |
Updates the specified user pool with the specified attributes.
|
default UpdateUserPoolClientResponse |
updateUserPoolClient(UpdateUserPoolClientRequest updateUserPoolClientRequest) |
Allows the developer to update the specified user pool client and password policy.
|
default VerifyUserAttributeResponse |
verifyUserAttribute(VerifyUserAttributeRequest verifyUserAttributeRequest) |
Verifies the specified user attributes in the user pool.
|
close
static final String SERVICE_NAME
static CognitoIdentityProviderClient create()
CognitoIdentityProviderClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static CognitoIdentityProviderClientBuilder builder()
CognitoIdentityProviderClient
.default AddCustomAttributesResponse addCustomAttributes(AddCustomAttributesRequest addCustomAttributesRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserImportInProgressException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Adds additional user attributes to the user pool schema.
addCustomAttributesRequest
- Represents the request to add custom attributes.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 is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserImportInProgressException
- This exception is thrown when you are trying to modify a user pool while a user import job is in progress
for that pool.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault AdminAddUserToGroupResponse adminAddUserToGroup(AdminAddUserToGroupRequest adminAddUserToGroupRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Adds the specified user to the specified group.
Requires developer credentials.
adminAddUserToGroupRequest
- 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 is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault AdminConfirmSignUpResponse adminConfirmSignUp(AdminConfirmSignUpRequest adminConfirmSignUpRequest) throws ResourceNotFoundException, InvalidParameterException, UnexpectedLambdaException, UserLambdaValidationException, NotAuthorizedException, TooManyFailedAttemptsException, InvalidLambdaResponseException, TooManyRequestsException, LimitExceededException, UserNotFoundException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Confirms user registration as an admin without using a confirmation code. Works on any user.
Requires developer credentials.
adminConfirmSignUpRequest
- Represents the request to confirm user registration.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 is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyFailedAttemptsException
- This exception is 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 is 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.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault AdminCreateUserResponse adminCreateUser(AdminCreateUserRequest adminCreateUserRequest) throws ResourceNotFoundException, InvalidParameterException, UserNotFoundException, UsernameExistsException, InvalidPasswordException, CodeDeliveryFailureException, UnexpectedLambdaException, UserLambdaValidationException, InvalidLambdaResponseException, PreconditionNotMetException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, TooManyRequestsException, NotAuthorizedException, UnsupportedUserStateException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Creates a new user in the specified user pool and sends a welcome message via email or phone (SMS). This message is based on a template that you configured in your call to CreateUserPool or UpdateUserPool. This template includes your custom sign-up instructions and placeholders for user name and temporary password.
Requires developer credentials.
adminCreateUserRequest
- Represents the request to create a user in the specified user pool.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.UserNotFoundException
- This exception is thrown when a user is not found.UsernameExistsException
- This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.InvalidPasswordException
- This exception is thrown when the Amazon Cognito service encounters an invalid password.CodeDeliveryFailureException
- This exception is thrown when a verification code fails to deliver successfully.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is 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.PreconditionNotMetException
- This exception is thrown when a precondition is not met.InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException
- This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UnsupportedUserStateException
- The request failed because the user is in an unsupported state.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault AdminDeleteUserResponse adminDeleteUser(AdminDeleteUserRequest adminDeleteUserRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Deletes a user as an administrator. Works on any user.
Requires developer credentials.
adminDeleteUserRequest
- Represents the request to delete a user as an administrator.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 is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault AdminDeleteUserAttributesResponse adminDeleteUserAttributes(AdminDeleteUserAttributesRequest adminDeleteUserAttributesRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Deletes the user attributes in a user pool as an administrator. Works on any user.
Requires developer credentials.
adminDeleteUserAttributesRequest
- Represents the request to delete user attributes as an administrator.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 is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault AdminDisableUserResponse adminDisableUser(AdminDisableUserRequest adminDisableUserRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Disables the specified user as an administrator. Works on any user.
Requires developer credentials.
adminDisableUserRequest
- Represents the request to disable any user as an administrator.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 is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault AdminEnableUserResponse adminEnableUser(AdminEnableUserRequest adminEnableUserRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Enables the specified user as an administrator. Works on any user.
Requires developer credentials.
adminEnableUserRequest
- Represents the request that enables the user as an administrator.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 is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault AdminForgetDeviceResponse adminForgetDevice(AdminForgetDeviceRequest adminForgetDeviceRequest) throws ResourceNotFoundException, InvalidParameterException, InvalidUserPoolConfigurationException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Forgets the device, as an administrator.
Requires developer credentials.
adminForgetDeviceRequest
- Sends the forgot device request, as an administrator.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.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault AdminGetDeviceResponse adminGetDevice(AdminGetDeviceRequest adminGetDeviceRequest) throws ResourceNotFoundException, InvalidParameterException, InvalidUserPoolConfigurationException, TooManyRequestsException, InternalErrorException, NotAuthorizedException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Gets the device, as an administrator.
Requires developer credentials.
adminGetDeviceRequest
- Represents the request to get the device, as an administrator.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.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.TooManyRequestsException
- This exception is 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.NotAuthorizedException
- This exception is thrown when a user is not authorized.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault AdminGetUserResponse adminGetUser(AdminGetUserRequest adminGetUserRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Gets the specified user by user name in a user pool as an administrator. Works on any user.
Requires developer credentials.
adminGetUserRequest
- Represents the request to get the specified user as an administrator.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 is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault AdminInitiateAuthResponse adminInitiateAuth(AdminInitiateAuthRequest adminInitiateAuthRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, UnexpectedLambdaException, InvalidUserPoolConfigurationException, UserLambdaValidationException, InvalidLambdaResponseException, MFAMethodNotFoundException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Initiates the authentication flow, as an administrator.
Requires developer credentials.
adminInitiateAuthRequest
- Initiates the authorization request, as an administrator.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 is thrown when a user is not authorized.TooManyRequestsException
- This exception is 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.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.UserLambdaValidationException
- This exception is 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.MFAMethodNotFoundException
- This exception is thrown when Amazon Cognito cannot find a multi-factor authentication (MFA) method.InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException
- This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault AdminListDevicesResponse adminListDevices(AdminListDevicesRequest adminListDevicesRequest) throws InvalidParameterException, ResourceNotFoundException, InvalidUserPoolConfigurationException, TooManyRequestsException, InternalErrorException, NotAuthorizedException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Lists devices, as an administrator.
Requires developer credentials.
adminListDevicesRequest
- Represents the request to list devices, as an administrator.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.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.TooManyRequestsException
- This exception is 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.NotAuthorizedException
- This exception is thrown when a user is not authorized.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault AdminListGroupsForUserResponse adminListGroupsForUser(AdminListGroupsForUserRequest adminListGroupsForUserRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Lists the groups that the user belongs to.
Requires developer credentials.
adminListGroupsForUserRequest
- 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 is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault AdminRemoveUserFromGroupResponse adminRemoveUserFromGroup(AdminRemoveUserFromGroupRequest adminRemoveUserFromGroupRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Removes the specified user from the specified group.
Requires developer credentials.
adminRemoveUserFromGroupRequest
- 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 is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault AdminResetUserPasswordResponse adminResetUserPassword(AdminResetUserPasswordRequest adminResetUserPasswordRequest) throws ResourceNotFoundException, InvalidParameterException, UnexpectedLambdaException, UserLambdaValidationException, NotAuthorizedException, InvalidLambdaResponseException, TooManyRequestsException, LimitExceededException, UserNotFoundException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Resets the specified user's password in a user pool as an administrator. Works on any user.
When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password.
Requires developer credentials.
adminResetUserPasswordRequest
- Represents the request to reset a user's password as an administrator.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 is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.NotAuthorizedException
- This exception is 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 is 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.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault AdminRespondToAuthChallengeResponse adminRespondToAuthChallenge(AdminRespondToAuthChallengeRequest adminRespondToAuthChallengeRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, CodeMismatchException, ExpiredCodeException, UnexpectedLambdaException, InvalidPasswordException, UserLambdaValidationException, InvalidLambdaResponseException, TooManyRequestsException, InvalidUserPoolConfigurationException, InternalErrorException, MFAMethodNotFoundException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, AliasExistsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Responds to an authentication challenge, as an administrator.
Requires developer credentials.
adminRespondToAuthChallengeRequest
- The request to respond to the authentication challenge, as an administrator.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 is 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.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.InvalidPasswordException
- This exception is thrown when the Amazon Cognito service encounters an invalid password.UserLambdaValidationException
- This exception is 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 is thrown when the user has made too many requests for a given operation.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.MFAMethodNotFoundException
- This exception is thrown when Amazon Cognito cannot find a multi-factor authentication (MFA) method.InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException
- This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.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.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault AdminSetUserSettingsResponse adminSetUserSettings(AdminSetUserSettingsRequest adminSetUserSettingsRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, UserNotFoundException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Sets all the user settings for a specified user name. Works on any user.
Requires developer credentials.
adminSetUserSettingsRequest
- Represents the request to set user settings as an administrator.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 is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault AdminUpdateDeviceStatusResponse adminUpdateDeviceStatus(AdminUpdateDeviceStatusRequest adminUpdateDeviceStatusRequest) throws InvalidParameterException, ResourceNotFoundException, InvalidUserPoolConfigurationException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Updates the device status as an administrator.
Requires developer credentials.
adminUpdateDeviceStatusRequest
- The request to update the device status, as an administrator.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.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault AdminUpdateUserAttributesResponse adminUpdateUserAttributes(AdminUpdateUserAttributesRequest adminUpdateUserAttributesRequest) throws ResourceNotFoundException, InvalidParameterException, UnexpectedLambdaException, UserLambdaValidationException, InvalidLambdaResponseException, AliasExistsException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.
For custom attributes, you must prepend the custom:
prefix to the attribute name.
In addition to updating user attributes, this API can also be used to mark phone and email as verified.
Requires developer credentials.
adminUpdateUserAttributesRequest
- Represents the request to update the user's attributes as an administrator.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 is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is 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 is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault AdminUserGlobalSignOutResponse adminUserGlobalSignOut(AdminUserGlobalSignOutRequest adminUserGlobalSignOutRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserNotFoundException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Signs out users from all devices, as an administrator.
Requires developer credentials.
adminUserGlobalSignOutRequest
- The request to sign out of all devices, as an administrator.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 is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ChangePasswordResponse changePassword(ChangePasswordRequest changePasswordRequest) throws ResourceNotFoundException, InvalidParameterException, InvalidPasswordException, NotAuthorizedException, TooManyRequestsException, LimitExceededException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Changes the password for a specified user in a user pool.
changePasswordRequest
- Represents the request to change a user password.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 is thrown when a user is not authorized.TooManyRequestsException
- This exception is 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.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ConfirmDeviceResponse confirmDevice(ConfirmDeviceRequest confirmDeviceRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, InvalidPasswordException, InvalidLambdaResponseException, UsernameExistsException, InvalidUserPoolConfigurationException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Confirms tracking of the device. This API call is the call that begins device tracking.
confirmDeviceRequest
- Confirms the device request.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 is 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.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ConfirmForgotPasswordResponse confirmForgotPassword(ConfirmForgotPasswordRequest confirmForgotPasswordRequest) throws ResourceNotFoundException, UnexpectedLambdaException, UserLambdaValidationException, InvalidParameterException, InvalidPasswordException, NotAuthorizedException, CodeMismatchException, ExpiredCodeException, TooManyFailedAttemptsException, InvalidLambdaResponseException, TooManyRequestsException, LimitExceededException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Allows a user to enter a confirmation code to reset a forgotten password.
confirmForgotPasswordRequest
- The request representing the confirmation for a password reset.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is 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 is 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 is 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 is 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.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ConfirmSignUpResponse confirmSignUp(ConfirmSignUpRequest confirmSignUpRequest) throws ResourceNotFoundException, InvalidParameterException, UnexpectedLambdaException, UserLambdaValidationException, NotAuthorizedException, TooManyFailedAttemptsException, CodeMismatchException, ExpiredCodeException, InvalidLambdaResponseException, AliasExistsException, TooManyRequestsException, LimitExceededException, UserNotFoundException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Confirms registration of a user and handles the existing alias from a previous user.
confirmSignUpRequest
- Represents the request to confirm registration of a user.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 is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyFailedAttemptsException
- This exception is 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 is 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.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateGroupResponse createGroup(CreateGroupRequest createGroupRequest) throws InvalidParameterException, GroupExistsException, ResourceNotFoundException, TooManyRequestsException, LimitExceededException, NotAuthorizedException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Creates a new group in the specified user pool.
Requires developer credentials.
createGroupRequest
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.GroupExistsException
- This exception is thrown when Amazon Cognito encounters a group that already exists in the user pool.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException
- This exception is 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.NotAuthorizedException
- This exception is thrown when a user is not authorized.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateIdentityProviderResponse createIdentityProvider(CreateIdentityProviderRequest createIdentityProviderRequest) throws InvalidParameterException, DuplicateProviderException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, LimitExceededException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Creates an identity provider for a user pool.
createIdentityProviderRequest
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.DuplicateProviderException
- This exception is thrown when the provider is already supported by the user pool.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateUserImportJobResponse createUserImportJob(CreateUserImportJobRequest createUserImportJobRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, PreconditionNotMetException, NotAuthorizedException, LimitExceededException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Creates the user import job.
createUserImportJobRequest
- Represents the request to create the user import job.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 is thrown when the user has made too many requests for a given operation.PreconditionNotMetException
- This exception is thrown when a precondition is not met.NotAuthorizedException
- This exception is thrown when a user is not authorized.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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateUserPoolResponse createUserPool(CreateUserPoolRequest createUserPoolRequest) throws InvalidParameterException, TooManyRequestsException, LimitExceededException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InvalidEmailRoleAccessPolicyException, NotAuthorizedException, UserPoolTaggingException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Creates a new Amazon Cognito user pool and sets the password policy for the pool.
createUserPoolRequest
- Represents the request to create a user pool.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is 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.InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException
- This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.InvalidEmailRoleAccessPolicyException
- This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code:
400.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserPoolTaggingException
- This exception is thrown when a user pool tag cannot be set or updated.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateUserPoolClientResponse createUserPoolClient(CreateUserPoolClientRequest createUserPoolClientRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, LimitExceededException, NotAuthorizedException, ScopeDoesNotExistException, InvalidOAuthFlowException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Creates the user pool client.
createUserPoolClientRequest
- Represents the request to create a user pool client.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 is 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.NotAuthorizedException
- This exception is thrown when a user is not authorized.ScopeDoesNotExistException
- This exception is thrown when the specified scope does not exist.InvalidOAuthFlowException
- This exception is thrown when the specified OAuth flow is invalid.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateUserPoolDomainResponse createUserPoolDomain(CreateUserPoolDomainRequest createUserPoolDomainRequest) throws InvalidParameterException, NotAuthorizedException, ResourceNotFoundException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Creates a new domain for a user pool.
createUserPoolDomainRequest
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException
- This exception is thrown when a user is not authorized.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteGroupResponse deleteGroup(DeleteGroupRequest deleteGroupRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Deletes a group. Currently only groups with no members can be deleted.
Requires developer credentials.
deleteGroupRequest
- 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 is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteIdentityProviderResponse deleteIdentityProvider(DeleteIdentityProviderRequest deleteIdentityProviderRequest) throws InvalidParameterException, UnsupportedIdentityProviderException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Deletes an identity provider for a user pool.
deleteIdentityProviderRequest
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnsupportedIdentityProviderException
- This exception is thrown when the specified identifier is not supported.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Allows a user to delete one's self.
deleteUserRequest
- Represents the request to delete a user.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 is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteUserAttributesResponse deleteUserAttributes(DeleteUserAttributesRequest deleteUserAttributesRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Deletes the attributes for a user.
deleteUserAttributesRequest
- Represents the request to delete user attributes.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 is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteUserPoolResponse deleteUserPool(DeleteUserPoolRequest deleteUserPoolRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserImportInProgressException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Deletes the specified Amazon Cognito user pool.
deleteUserPoolRequest
- Represents the request to delete a user pool.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 is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserImportInProgressException
- This exception is thrown when you are trying to modify a user pool while a user import job is in progress
for that pool.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteUserPoolClientResponse deleteUserPoolClient(DeleteUserPoolClientRequest deleteUserPoolClientRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Allows the developer to delete the user pool client.
deleteUserPoolClientRequest
- Represents the request to delete a user pool client.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 is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteUserPoolDomainResponse deleteUserPoolDomain(DeleteUserPoolDomainRequest deleteUserPoolDomainRequest) throws NotAuthorizedException, InvalidParameterException, ResourceNotFoundException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Deletes a domain for a user pool.
deleteUserPoolDomainRequest
- NotAuthorizedException
- This exception is thrown when a user is not authorized.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.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeIdentityProviderResponse describeIdentityProvider(DescribeIdentityProviderRequest describeIdentityProviderRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Gets information about a specific identity provider.
describeIdentityProviderRequest
- 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.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeUserImportJobResponse describeUserImportJob(DescribeUserImportJobRequest describeUserImportJobRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Describes the user import job.
describeUserImportJobRequest
- Represents the request to describe the user import job.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 is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeUserPoolResponse describeUserPool(DescribeUserPoolRequest describeUserPoolRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UserPoolTaggingException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Returns the configuration information and metadata of the specified user pool.
describeUserPoolRequest
- Represents the request to describe the user pool.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 is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserPoolTaggingException
- This exception is thrown when a user pool tag cannot be set or updated.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeUserPoolClientResponse describeUserPoolClient(DescribeUserPoolClientRequest describeUserPoolClientRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Client method for returning the configuration information and metadata of the specified user pool client.
describeUserPoolClientRequest
- Represents the request to describe a user pool client.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 is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeUserPoolDomainResponse describeUserPoolDomain(DescribeUserPoolDomainRequest describeUserPoolDomainRequest) throws NotAuthorizedException, InvalidParameterException, ResourceNotFoundException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Gets information about a domain.
describeUserPoolDomainRequest
- NotAuthorizedException
- This exception is thrown when a user is not authorized.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.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ForgetDeviceResponse forgetDevice(ForgetDeviceRequest forgetDeviceRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, InvalidUserPoolConfigurationException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Forgets the specified device.
forgetDeviceRequest
- Represents the request to forget the device.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 is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ForgotPasswordResponse forgotPassword(ForgotPasswordRequest forgotPasswordRequest) throws ResourceNotFoundException, InvalidParameterException, UnexpectedLambdaException, UserLambdaValidationException, NotAuthorizedException, InvalidLambdaResponseException, TooManyRequestsException, LimitExceededException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InvalidEmailRoleAccessPolicyException, CodeDeliveryFailureException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Calling this API causes a message to be sent to the end user with a confirmation code that is required to change
the user's password. For the Username
parameter, you can use the username or user alias. If a
verified phone number exists for the user, the confirmation code is sent to the phone number. Otherwise, if a
verified email exists, the confirmation code is sent to the email. If neither a verified phone number nor a
verified email exists, InvalidParameterException
is thrown. To use the confirmation code for
resetting the password, call ConfirmForgotPassword.
forgotPasswordRequest
- Represents the request to reset a user's password.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 is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.NotAuthorizedException
- This exception is 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 is 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.InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException
- This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.InvalidEmailRoleAccessPolicyException
- This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code:
400.CodeDeliveryFailureException
- This exception is thrown when a verification code fails to deliver successfully.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetCSVHeaderResponse getCSVHeader(GetCSVHeaderRequest getCSVHeaderRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Gets the header information for the .csv file to be used as input for the user import job.
getCSVHeaderRequest
- Represents the request to get the header information for the .csv file for the user import job.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 is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetDeviceResponse getDevice(GetDeviceRequest getDeviceRequest) throws ResourceNotFoundException, InvalidParameterException, InvalidUserPoolConfigurationException, NotAuthorizedException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Gets the device.
getDeviceRequest
- Represents the request to get the device.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.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetGroupResponse getGroup(GetGroupRequest getGroupRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Gets a group.
Requires developer credentials.
getGroupRequest
- 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 is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetIdentityProviderByIdentifierResponse getIdentityProviderByIdentifier(GetIdentityProviderByIdentifierRequest getIdentityProviderByIdentifierRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Gets the specified identity provider.
getIdentityProviderByIdentifierRequest
- 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.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetUserResponse getUser(GetUserRequest getUserRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Gets the user attributes and metadata for a user.
getUserRequest
- Represents the request to get information about the user.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 is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetUserAttributeVerificationCodeResponse getUserAttributeVerificationCode(GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, UnexpectedLambdaException, UserLambdaValidationException, InvalidLambdaResponseException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InvalidEmailRoleAccessPolicyException, CodeDeliveryFailureException, LimitExceededException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Gets the user attribute verification code for the specified attribute name.
getUserAttributeVerificationCodeRequest
- Represents the request to get user attribute verification.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 is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is 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.InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException
- This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.InvalidEmailRoleAccessPolicyException
- This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code:
400.CodeDeliveryFailureException
- This exception is thrown when a verification code fails to deliver successfully.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GlobalSignOutResponse globalSignOut(GlobalSignOutRequest globalSignOutRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, PasswordResetRequiredException, UserNotConfirmedException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Signs out users from all devices.
globalSignOutRequest
- Represents the request to sign out all devices.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 is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault InitiateAuthResponse initiateAuth(InitiateAuthRequest initiateAuthRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, TooManyRequestsException, UnexpectedLambdaException, InvalidUserPoolConfigurationException, UserLambdaValidationException, InvalidLambdaResponseException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Initiates the authentication flow.
initiateAuthRequest
- Initiates the authentication request.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 is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.UserLambdaValidationException
- This exception is 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.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListDevicesResponse listDevices(ListDevicesRequest listDevicesRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, InvalidUserPoolConfigurationException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Lists the devices.
listDevicesRequest
- Represents the request to list the devices.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.NotAuthorizedException
- This exception is thrown when a user is not authorized.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListGroupsResponse listGroups(ListGroupsRequest listGroupsRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Lists the groups associated with a user pool.
Requires developer credentials.
listGroupsRequest
- 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 is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListIdentityProvidersResponse listIdentityProviders(ListIdentityProvidersRequest listIdentityProvidersRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Lists information about all identity providers for a user pool.
listIdentityProvidersRequest
- 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.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListUserImportJobsResponse listUserImportJobs(ListUserImportJobsRequest listUserImportJobsRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Lists the user import jobs.
listUserImportJobsRequest
- Represents the request to list the user import jobs.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 is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListUserPoolClientsResponse listUserPoolClients(ListUserPoolClientsRequest listUserPoolClientsRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Lists the clients that have been created for the specified user pool.
listUserPoolClientsRequest
- Represents the request to list the user pool clients.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 is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListUserPoolsResponse listUserPools(ListUserPoolsRequest listUserPoolsRequest) throws InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Lists the user pools associated with an AWS account.
listUserPoolsRequest
- Represents the request to list user pools.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListUsersResponse listUsers(ListUsersRequest listUsersRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Lists the users in the Amazon Cognito user pool.
listUsersRequest
- Represents the request to list users.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 is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListUsersInGroupResponse listUsersInGroup(ListUsersInGroupRequest listUsersInGroupRequest) throws InvalidParameterException, ResourceNotFoundException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Lists the users in the specified group.
Requires developer credentials.
listUsersInGroupRequest
- 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 is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ResendConfirmationCodeResponse resendConfirmationCode(ResendConfirmationCodeRequest resendConfirmationCodeRequest) throws ResourceNotFoundException, InvalidParameterException, UnexpectedLambdaException, UserLambdaValidationException, NotAuthorizedException, InvalidLambdaResponseException, TooManyRequestsException, LimitExceededException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InvalidEmailRoleAccessPolicyException, CodeDeliveryFailureException, UserNotFoundException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
resendConfirmationCodeRequest
- Represents the request to resend the confirmation code.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 is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.NotAuthorizedException
- This exception is 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 is 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.InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException
- This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.InvalidEmailRoleAccessPolicyException
- This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code:
400.CodeDeliveryFailureException
- This exception is thrown when a verification code fails to deliver successfully.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RespondToAuthChallengeResponse respondToAuthChallenge(RespondToAuthChallengeRequest respondToAuthChallengeRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, CodeMismatchException, ExpiredCodeException, UnexpectedLambdaException, UserLambdaValidationException, InvalidPasswordException, InvalidLambdaResponseException, TooManyRequestsException, InvalidUserPoolConfigurationException, MFAMethodNotFoundException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, AliasExistsException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Responds to the authentication challenge.
respondToAuthChallengeRequest
- The request to respond to an authentication challenge.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 is 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.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.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.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.MFAMethodNotFoundException
- This exception is thrown when Amazon Cognito cannot find a multi-factor authentication (MFA) method.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException
- This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault SetUserSettingsResponse setUserSettings(SetUserSettingsRequest setUserSettingsRequest) throws ResourceNotFoundException, InvalidParameterException, NotAuthorizedException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
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.
setUserSettingsRequest
- Represents the request to set user settings.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 is thrown when a user is not authorized.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault SignUpResponse signUp(SignUpRequest signUpRequest) throws ResourceNotFoundException, InvalidParameterException, UnexpectedLambdaException, UserLambdaValidationException, NotAuthorizedException, InvalidPasswordException, InvalidLambdaResponseException, UsernameExistsException, TooManyRequestsException, InternalErrorException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InvalidEmailRoleAccessPolicyException, CodeDeliveryFailureException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Registers the user in the specified user pool and creates a user name, password, and user attributes.
signUpRequest
- Represents the request to register a user.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 is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.NotAuthorizedException
- This exception is 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 is 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.InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException
- This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.InvalidEmailRoleAccessPolicyException
- This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code:
400.CodeDeliveryFailureException
- This exception is thrown when a verification code fails to deliver successfully.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault StartUserImportJobResponse startUserImportJob(StartUserImportJobRequest startUserImportJobRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, InternalErrorException, PreconditionNotMetException, NotAuthorizedException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Starts the user import.
startUserImportJobRequest
- Represents the request to start the user import job.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 is 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.PreconditionNotMetException
- This exception is thrown when a precondition is not met.NotAuthorizedException
- This exception is thrown when a user is not authorized.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault StopUserImportJobResponse stopUserImportJob(StopUserImportJobRequest stopUserImportJobRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, InternalErrorException, PreconditionNotMetException, NotAuthorizedException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Stops the user import job.
stopUserImportJobRequest
- Represents the request to stop the user import job.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 is 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.PreconditionNotMetException
- This exception is thrown when a precondition is not met.NotAuthorizedException
- This exception is thrown when a user is not authorized.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateDeviceStatusResponse updateDeviceStatus(UpdateDeviceStatusRequest updateDeviceStatusRequest) throws InvalidParameterException, ResourceNotFoundException, NotAuthorizedException, InvalidUserPoolConfigurationException, TooManyRequestsException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Updates the device status.
updateDeviceStatusRequest
- Represents the request to update the device status.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.NotAuthorizedException
- This exception is thrown when a user is not authorized.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateGroupResponse updateGroup(UpdateGroupRequest updateGroupRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Updates the specified group with the specified attributes.
Requires developer credentials.
updateGroupRequest
- 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 is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateIdentityProviderResponse updateIdentityProvider(UpdateIdentityProviderRequest updateIdentityProviderRequest) throws InvalidParameterException, UnsupportedIdentityProviderException, ResourceNotFoundException, NotAuthorizedException, TooManyRequestsException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Updates identity provider information for a user pool.
updateIdentityProviderRequest
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnsupportedIdentityProviderException
- This exception is thrown when the specified identifier is not supported.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateUserAttributesResponse updateUserAttributes(UpdateUserAttributesRequest updateUserAttributesRequest) throws ResourceNotFoundException, InvalidParameterException, CodeMismatchException, ExpiredCodeException, NotAuthorizedException, UnexpectedLambdaException, UserLambdaValidationException, InvalidLambdaResponseException, TooManyRequestsException, AliasExistsException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InvalidEmailRoleAccessPolicyException, CodeDeliveryFailureException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Allows a user to update a specific attribute (one at a time).
updateUserAttributesRequest
- Represents the request to update user attributes.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 is thrown when a user is not authorized.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is 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 is 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.InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException
- This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.InvalidEmailRoleAccessPolicyException
- This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code:
400.CodeDeliveryFailureException
- This exception is thrown when a verification code fails to deliver successfully.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateUserPoolResponse updateUserPool(UpdateUserPoolRequest updateUserPoolRequest) throws ResourceNotFoundException, InvalidParameterException, ConcurrentModificationException, TooManyRequestsException, NotAuthorizedException, UserImportInProgressException, InternalErrorException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, UserPoolTaggingException, InvalidEmailRoleAccessPolicyException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Updates the specified user pool with the specified attributes.
updateUserPoolRequest
- Represents the request to update the user pool.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 is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserImportInProgressException
- This exception is thrown when you are trying to modify a user pool while a user import job is in progress
for that pool.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException
- This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.UserPoolTaggingException
- This exception is thrown when a user pool tag cannot be set or updated.InvalidEmailRoleAccessPolicyException
- This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code:
400.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateUserPoolClientResponse updateUserPoolClient(UpdateUserPoolClientRequest updateUserPoolClientRequest) throws ResourceNotFoundException, InvalidParameterException, TooManyRequestsException, NotAuthorizedException, ScopeDoesNotExistException, InvalidOAuthFlowException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Allows the developer to update the specified user pool client and password policy.
updateUserPoolClientRequest
- Represents the request to update the user pool client.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 is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.ScopeDoesNotExistException
- This exception is thrown when the specified scope does not exist.InvalidOAuthFlowException
- This exception is thrown when the specified OAuth flow is invalid.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault VerifyUserAttributeResponse verifyUserAttribute(VerifyUserAttributeRequest verifyUserAttributeRequest) throws ResourceNotFoundException, InvalidParameterException, CodeMismatchException, ExpiredCodeException, NotAuthorizedException, TooManyRequestsException, LimitExceededException, PasswordResetRequiredException, UserNotFoundException, UserNotConfirmedException, InternalErrorException, SdkBaseException, SdkClientException, CognitoIdentityProviderException
Verifies the specified user attributes in the user pool.
verifyUserAttributeRequest
- Represents the request to verify user attributes.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 is thrown when a user is not authorized.TooManyRequestsException
- This exception is 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.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CognitoIdentityProviderException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typestatic ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.