AWSCognitoIdentityProviderClient (AWS Java SDK for Amazon Cognito Identity Provider Service 1.11.99 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.cognitoidp.AWSCognitoIdentityProviderClient

All Implemented Interfaces:

AWSCognitoIdentityProvider

Direct Known Subclasses:

AWSCognitoIdentityProviderAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSCognitoIdentityProviderClient
extends AmazonWebServiceClient
implements AWSCognitoIdentityProvider
```
Client for accessing Amazon Cognito Identity Provider. All service calls made using this client are blocking, and will not return until the service call completes.

Using the Amazon Cognito Your User Pools API, you can create a user pool to manage directories and users. You can authenticate a user to obtain tokens related to user identity and access policies.

This API reference provides information about user pools in Amazon Cognito Your User Pools.

For more information, see the Amazon Cognito Documentation.

Field Summary

Fields
Modifier and Type Field and Description

protected static ClientConfigurationFactory configFactory
Client configuration factory providing ClientConfigurations tailored to this client
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
- Fields inherited from interface com.amazonaws.services.cognitoidp.AWSCognitoIdentityProvider
  ENDPOINT_PREFIX

Fields
Modifier and Type	Field and Description
`protected static ClientConfigurationFactory`	`configFactory` Client configuration factory providing ClientConfigurations tailored to this client

Constructor Summary

Constructors
Constructor and Description
`AWSCognitoIdentityProviderClient()` Deprecated. use `AWSCognitoIdentityProviderClientBuilder.defaultClient()`
`AWSCognitoIdentityProviderClient(AWSCredentials awsCredentials)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` for example: `AWSCognitoIdentityProviderClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();`
`AWSCognitoIdentityProviderClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`
`AWSCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)`
`AWSCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`
`AWSCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)` and `AwsClientBuilder.withMetricsCollector(RequestMetricCollector)`
`AWSCognitoIdentityProviderClient(ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AddCustomAttributesResult`	`addCustomAttributes(AddCustomAttributesRequest addCustomAttributesRequest)` Adds additional user attributes to the user pool schema.
`AdminAddUserToGroupResult`	`adminAddUserToGroup(AdminAddUserToGroupRequest adminAddUserToGroupRequest)` Adds the specified user to the specified group.
`AdminConfirmSignUpResult`	`adminConfirmSignUp(AdminConfirmSignUpRequest adminConfirmSignUpRequest)` Confirms user registration as an admin without using a confirmation code.
`AdminCreateUserResult`	`adminCreateUser(AdminCreateUserRequest adminCreateUserRequest)` Creates a new user in the specified user pool and sends a welcome message via email or phone (SMS).
`AdminDeleteUserResult`	`adminDeleteUser(AdminDeleteUserRequest adminDeleteUserRequest)` Deletes a user as an administrator.
`AdminDeleteUserAttributesResult`	`adminDeleteUserAttributes(AdminDeleteUserAttributesRequest adminDeleteUserAttributesRequest)` Deletes the user attributes in a user pool as an administrator.
`AdminDisableUserResult`	`adminDisableUser(AdminDisableUserRequest adminDisableUserRequest)` Disables the specified user as an administrator.
`AdminEnableUserResult`	`adminEnableUser(AdminEnableUserRequest adminEnableUserRequest)` Enables the specified user as an administrator.
`AdminForgetDeviceResult`	`adminForgetDevice(AdminForgetDeviceRequest adminForgetDeviceRequest)` Forgets the device, as an administrator.
`AdminGetDeviceResult`	`adminGetDevice(AdminGetDeviceRequest adminGetDeviceRequest)` Gets the device, as an administrator.
`AdminGetUserResult`	`adminGetUser(AdminGetUserRequest adminGetUserRequest)` Gets the specified user by user name in a user pool as an administrator.
`AdminInitiateAuthResult`	`adminInitiateAuth(AdminInitiateAuthRequest adminInitiateAuthRequest)` Initiates the authentication flow, as an administrator.
`AdminListDevicesResult`	`adminListDevices(AdminListDevicesRequest adminListDevicesRequest)` Lists devices, as an administrator.
`AdminListGroupsForUserResult`	`adminListGroupsForUser(AdminListGroupsForUserRequest adminListGroupsForUserRequest)` Lists the groups that the user belongs to.
`AdminRemoveUserFromGroupResult`	`adminRemoveUserFromGroup(AdminRemoveUserFromGroupRequest adminRemoveUserFromGroupRequest)` Removes the specified user from the specified group.
`AdminResetUserPasswordResult`	`adminResetUserPassword(AdminResetUserPasswordRequest adminResetUserPasswordRequest)` Resets the specified user's password in a user pool as an administrator.
`AdminRespondToAuthChallengeResult`	`adminRespondToAuthChallenge(AdminRespondToAuthChallengeRequest adminRespondToAuthChallengeRequest)` Responds to an authentication challenge, as an administrator.
`AdminSetUserSettingsResult`	`adminSetUserSettings(AdminSetUserSettingsRequest adminSetUserSettingsRequest)` Sets all the user settings for a specified user name.
`AdminUpdateDeviceStatusResult`	`adminUpdateDeviceStatus(AdminUpdateDeviceStatusRequest adminUpdateDeviceStatusRequest)` Updates the device status as an administrator.
`AdminUpdateUserAttributesResult`	`adminUpdateUserAttributes(AdminUpdateUserAttributesRequest adminUpdateUserAttributesRequest)` Updates the specified user's attributes, including developer attributes, as an administrator.
`AdminUserGlobalSignOutResult`	`adminUserGlobalSignOut(AdminUserGlobalSignOutRequest adminUserGlobalSignOutRequest)` Signs out users from all devices, as an administrator.
`static AWSCognitoIdentityProviderClientBuilder`	`builder()`
`ChangePasswordResult`	`changePassword(ChangePasswordRequest changePasswordRequest)` Changes the password for a specified user in a user pool.
`ConfirmDeviceResult`	`confirmDevice(ConfirmDeviceRequest confirmDeviceRequest)` Confirms tracking of the device.
`ConfirmForgotPasswordResult`	`confirmForgotPassword(ConfirmForgotPasswordRequest confirmForgotPasswordRequest)` Allows a user to enter a code provided when they reset their password to update their password.
`ConfirmSignUpResult`	`confirmSignUp(ConfirmSignUpRequest confirmSignUpRequest)` Confirms registration of a user and handles the existing alias from a previous user.
`CreateGroupResult`	`createGroup(CreateGroupRequest createGroupRequest)` Creates a new group in the specified user pool.
`CreateUserImportJobResult`	`createUserImportJob(CreateUserImportJobRequest createUserImportJobRequest)` Creates the user import job.
`CreateUserPoolResult`	`createUserPool(CreateUserPoolRequest createUserPoolRequest)` Creates a new Amazon Cognito user pool and sets the password policy for the pool.
`CreateUserPoolClientResult`	`createUserPoolClient(CreateUserPoolClientRequest createUserPoolClientRequest)` Creates the user pool client.
`DeleteGroupResult`	`deleteGroup(DeleteGroupRequest deleteGroupRequest)` Deletes a group.
`DeleteUserResult`	`deleteUser(DeleteUserRequest deleteUserRequest)` Allows a user to delete one's self.
`DeleteUserAttributesResult`	`deleteUserAttributes(DeleteUserAttributesRequest deleteUserAttributesRequest)` Deletes the attributes for a user.
`DeleteUserPoolResult`	`deleteUserPool(DeleteUserPoolRequest deleteUserPoolRequest)` Deletes the specified Amazon Cognito user pool.
`DeleteUserPoolClientResult`	`deleteUserPoolClient(DeleteUserPoolClientRequest deleteUserPoolClientRequest)` Allows the developer to delete the user pool client.
`DescribeUserImportJobResult`	`describeUserImportJob(DescribeUserImportJobRequest describeUserImportJobRequest)` Describes the user import job.
`DescribeUserPoolResult`	`describeUserPool(DescribeUserPoolRequest describeUserPoolRequest)` Returns the configuration information and metadata of the specified user pool.
`DescribeUserPoolClientResult`	`describeUserPoolClient(DescribeUserPoolClientRequest describeUserPoolClientRequest)` Client method for returning the configuration information and metadata of the specified user pool client.
`ForgetDeviceResult`	`forgetDevice(ForgetDeviceRequest forgetDeviceRequest)` Forgets the specified device.
`ForgotPasswordResult`	`forgotPassword(ForgotPasswordRequest forgotPasswordRequest)` Retrieves the password for the specified client ID or username.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
`GetCSVHeaderResult`	`getCSVHeader(GetCSVHeaderRequest getCSVHeaderRequest)` Gets the header information for the .csv file to be used as input for the user import job.
`GetDeviceResult`	`getDevice(GetDeviceRequest getDeviceRequest)` Gets the device.
`GetGroupResult`	`getGroup(GetGroupRequest getGroupRequest)` Gets a group.
`GetUserResult`	`getUser(GetUserRequest getUserRequest)` Gets the user attributes and metadata for a user.
`GetUserAttributeVerificationCodeResult`	`getUserAttributeVerificationCode(GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest)` Gets the user attribute verification code for the specified attribute name.
`GlobalSignOutResult`	`globalSignOut(GlobalSignOutRequest globalSignOutRequest)` Signs out users from all devices.
`InitiateAuthResult`	`initiateAuth(InitiateAuthRequest initiateAuthRequest)` Initiates the authentication flow.
`ListDevicesResult`	`listDevices(ListDevicesRequest listDevicesRequest)` Lists the devices.
`ListGroupsResult`	`listGroups(ListGroupsRequest listGroupsRequest)` Lists the groups associated with a user pool.
`ListUserImportJobsResult`	`listUserImportJobs(ListUserImportJobsRequest listUserImportJobsRequest)` Lists the user import jobs.
`ListUserPoolClientsResult`	`listUserPoolClients(ListUserPoolClientsRequest listUserPoolClientsRequest)` Lists the clients that have been created for the specified user pool.
`ListUserPoolsResult`	`listUserPools(ListUserPoolsRequest listUserPoolsRequest)` Lists the user pools associated with an AWS account.
`ListUsersResult`	`listUsers(ListUsersRequest listUsersRequest)` Lists the users in the Amazon Cognito user pool.
`ListUsersInGroupResult`	`listUsersInGroup(ListUsersInGroupRequest listUsersInGroupRequest)` Lists the users in the specified group.
`ResendConfirmationCodeResult`	`resendConfirmationCode(ResendConfirmationCodeRequest resendConfirmationCodeRequest)` Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
`RespondToAuthChallengeResult`	`respondToAuthChallenge(RespondToAuthChallengeRequest respondToAuthChallengeRequest)` Responds to the authentication challenge.
`SetUserSettingsResult`	`setUserSettings(SetUserSettingsRequest setUserSettingsRequest)` Sets the user settings like multi-factor authentication (MFA).
`SignUpResult`	`signUp(SignUpRequest signUpRequest)` Registers the user in the specified user pool and creates a user name, password, and user attributes.
`StartUserImportJobResult`	`startUserImportJob(StartUserImportJobRequest startUserImportJobRequest)` Starts the user import.
`StopUserImportJobResult`	`stopUserImportJob(StopUserImportJobRequest stopUserImportJobRequest)` Stops the user import job.
`UpdateDeviceStatusResult`	`updateDeviceStatus(UpdateDeviceStatusRequest updateDeviceStatusRequest)` Updates the device status.
`UpdateGroupResult`	`updateGroup(UpdateGroupRequest updateGroupRequest)` Updates the specified group with the specified attributes.
`UpdateUserAttributesResult`	`updateUserAttributes(UpdateUserAttributesRequest updateUserAttributesRequest)` Allows a user to update a specific attribute (one at a time).
`UpdateUserPoolResult`	`updateUserPool(UpdateUserPoolRequest updateUserPoolRequest)` Updates the specified user pool with the specified attributes.
`UpdateUserPoolClientResult`	`updateUserPoolClient(UpdateUserPoolClientRequest updateUserPoolClientRequest)` Allows the developer to update the specified user pool client and password policy.
`VerifyUserAttributeResult`	`verifyUserAttribute(VerifyUserAttributeRequest verifyUserAttributeRequest)` Verifies the specified user attributes in the user pool.

Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerProvider, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.cognitoidp.AWSCognitoIdentityProvider
setEndpoint, setRegion, shutdown

- Field Detail
  - configFactory
```
protected static final ClientConfigurationFactory configFactory
```
    Client configuration factory providing ClientConfigurations tailored to this client
- Constructor Detail
  - AWSCognitoIdentityProviderClient
```
@Deprecated
public AWSCognitoIdentityProviderClient()
```
    Deprecated. use AWSCognitoIdentityProviderClientBuilder.defaultClient()
    Constructs a new client to invoke service methods on Amazon Cognito Identity Provider. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    See Also:
    
    DefaultAWSCredentialsProviderChain
  - AWSCognitoIdentityProviderClient
```
@Deprecated
public AWSCognitoIdentityProviderClient(ClientConfiguration clientConfiguration)
```
    Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    Constructs a new client to invoke service methods on Amazon Cognito Identity Provider. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    Parameters:
    
    clientConfiguration - The client configuration options controlling how this client connects to Amazon Cognito Identity Provider (ex: proxy settings, retry counts, etc.).
    
    See Also:
    
    DefaultAWSCredentialsProviderChain
  - AWSCognitoIdentityProviderClient
```
@Deprecated
public AWSCognitoIdentityProviderClient(AWSCredentials awsCredentials)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSCognitoIdentityProviderClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
    
    Constructs a new client to invoke service methods on Amazon Cognito Identity Provider using the specified AWS account credentials.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
  - AWSCognitoIdentityProviderClient
```
@Deprecated
public AWSCognitoIdentityProviderClient(AWSCredentials awsCredentials,
                                                    ClientConfiguration clientConfiguration)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    
    Constructs a new client to invoke service methods on Amazon Cognito Identity Provider using the specified AWS account credentials and client configuration options.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
    
    clientConfiguration - The client configuration options controlling how this client connects to Amazon Cognito Identity Provider (ex: proxy settings, retry counts, etc.).
  - AWSCognitoIdentityProviderClient
```
@Deprecated
public AWSCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
    
    Constructs a new client to invoke service methods on Amazon Cognito Identity Provider using the specified AWS account credentials provider.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
  - AWSCognitoIdentityProviderClient
```
@Deprecated
public AWSCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider,
                                                    ClientConfiguration clientConfiguration)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    
    Constructs a new client to invoke service methods on Amazon Cognito Identity Provider using the specified AWS account credentials provider and client configuration options.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    
    clientConfiguration - The client configuration options controlling how this client connects to Amazon Cognito Identity Provider (ex: proxy settings, retry counts, etc.).
  - AWSCognitoIdentityProviderClient
```
@Deprecated
public AWSCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider,
                                                    ClientConfiguration clientConfiguration,
                                                    RequestMetricCollector requestMetricCollector)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
    
    Constructs a new client to invoke service methods on Amazon Cognito Identity Provider using the specified AWS account credentials provider, client configuration options, and request metric collector.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    
    clientConfiguration - The client configuration options controlling how this client connects to Amazon Cognito Identity Provider (ex: proxy settings, retry counts, etc.).
    
    requestMetricCollector - optional request metric collector
- Method Detail
  - builder
```
public static AWSCognitoIdentityProviderClientBuilder builder()
```
  - addCustomAttributes
```
public AddCustomAttributesResult addCustomAttributes(AddCustomAttributesRequest addCustomAttributesRequest)
```
    Adds additional user attributes to the user pool schema.
    
    Specified by:
    
    addCustomAttributes in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    addCustomAttributesRequest - Represents the request to add custom attributes.
    
    Returns:
    
    Result of the AddCustomAttributes operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    NotAuthorizedException - This exception gets 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.
    
    See Also:
    
    AWS API Documentation
  - adminAddUserToGroup
```
public AdminAddUserToGroupResult adminAddUserToGroup(AdminAddUserToGroupRequest adminAddUserToGroupRequest)
```
    Adds the specified user to the specified group.
    
    Requires developer credentials.
    
    Specified by:
    
    adminAddUserToGroup in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    adminAddUserToGroupRequest -
    
    Returns:
    
    Result of the AdminAddUserToGroup operation returned by the service.
    
    Throws:
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    NotAuthorizedException - This exception gets 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.
    
    See Also:
    
    AWS API Documentation
  - adminConfirmSignUp
```
public AdminConfirmSignUpResult adminConfirmSignUp(AdminConfirmSignUpRequest adminConfirmSignUpRequest)
```
    Confirms user registration as an admin without using a confirmation code. Works on any user.
    
    Requires developer credentials.
    
    Specified by:
    
    adminConfirmSignUp in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    adminConfirmSignUpRequest - Represents the request to confirm user registration.
    
    Returns:
    
    Result of the AdminConfirmSignUp operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    UnexpectedLambdaException - This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.
    
    UserLambdaValidationException - This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    TooManyFailedAttemptsException - This exception gets thrown when the user has made too many failed attempts for a given action (e.g., sign in).
    
    InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    LimitExceededException - This exception is thrown when a user exceeds the limit for a requested AWS resource.
    
    UserNotFoundException - This exception is thrown when a user is not found.
    
    InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.
    
    See Also:
    
    AWS API Documentation
  - adminCreateUser
```
public AdminCreateUserResult adminCreateUser(AdminCreateUserRequest adminCreateUserRequest)
```
    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.
    
    Specified by:
    
    adminCreateUser in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    adminCreateUserRequest - Represents the request to create a user in the specified user pool.
    
    Returns:
    
    Result of the AdminCreateUser operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    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 gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.
    
    UserLambdaValidationException - This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
    
    InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
    
    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 gets thrown when the user has made too many requests for a given operation.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    UnsupportedUserStateException - The request failed because the user is in an unsupported state.
    
    InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.
    
    See Also:
    
    AWS API Documentation
  - adminDeleteUser
```
public AdminDeleteUserResult adminDeleteUser(AdminDeleteUserRequest adminDeleteUserRequest)
```
    Deletes a user as an administrator. Works on any user.
    
    Requires developer credentials.
    
    Specified by:
    
    adminDeleteUser in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    adminDeleteUserRequest - Represents the request to delete a user as an administrator.
    
    Returns:
    
    Result of the AdminDeleteUser operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    NotAuthorizedException - This exception gets 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.
    
    See Also:
    
    AWS API Documentation
  - adminDeleteUserAttributes
```
public AdminDeleteUserAttributesResult adminDeleteUserAttributes(AdminDeleteUserAttributesRequest adminDeleteUserAttributesRequest)
```
    Deletes the user attributes in a user pool as an administrator. Works on any user.
    
    Requires developer credentials.
    
    Specified by:
    
    adminDeleteUserAttributes in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    adminDeleteUserAttributesRequest - Represents the request to delete user attributes as an administrator.
    
    Returns:
    
    Result of the AdminDeleteUserAttributes operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    NotAuthorizedException - This exception gets 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.
    
    See Also:
    
    AWS API Documentation
  - adminDisableUser
```
public AdminDisableUserResult adminDisableUser(AdminDisableUserRequest adminDisableUserRequest)
```
    Disables the specified user as an administrator. Works on any user.
    
    Requires developer credentials.
    
    Specified by:
    
    adminDisableUser in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    adminDisableUserRequest - Represents the request to disable any user as an administrator.
    
    Returns:
    
    Result of the AdminDisableUser operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    NotAuthorizedException - This exception gets 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.
    
    See Also:
    
    AWS API Documentation
  - adminEnableUser
```
public AdminEnableUserResult adminEnableUser(AdminEnableUserRequest adminEnableUserRequest)
```
    Enables the specified user as an administrator. Works on any user.
    
    Requires developer credentials.
    
    Specified by:
    
    adminEnableUser in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    adminEnableUserRequest - Represents the request that enables the user as an administrator.
    
    Returns:
    
    Result of the AdminEnableUser operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    NotAuthorizedException - This exception gets 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.
    
    See Also:
    
    AWS API Documentation
  - adminForgetDevice
```
public AdminForgetDeviceResult adminForgetDevice(AdminForgetDeviceRequest adminForgetDeviceRequest)
```
    Forgets the device, as an administrator.
    
    Requires developer credentials.
    
    Specified by:
    
    adminForgetDevice in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    adminForgetDeviceRequest - Sends the forgot device request, as an administrator.
    
    Returns:
    
    Result of the AdminForgetDevice operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    InvalidUserPoolConfigurationException - This exception is thrown when the user pool configuration is invalid.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    UserNotFoundException - This exception is thrown when a user is not found.
    
    InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.
    
    See Also:
    
    AWS API Documentation
  - adminGetDevice
```
public AdminGetDeviceResult adminGetDevice(AdminGetDeviceRequest adminGetDeviceRequest)
```
    Gets the device, as an administrator.
    
    Requires developer credentials.
    
    Specified by:
    
    adminGetDevice in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    adminGetDeviceRequest - Represents the request to get the device, as an administrator.
    
    Returns:
    
    Result of the AdminGetDevice operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    InvalidUserPoolConfigurationException - This exception is thrown when the user pool configuration is invalid.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    See Also:
    
    AWS API Documentation
  - adminGetUser
```
public AdminGetUserResult adminGetUser(AdminGetUserRequest adminGetUserRequest)
```
    Gets the specified user by user name in a user pool as an administrator. Works on any user.
    
    Requires developer credentials.
    
    Specified by:
    
    adminGetUser in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    adminGetUserRequest - Represents the request to get the specified user as an administrator.
    
    Returns:
    
    Result of the AdminGetUser operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    NotAuthorizedException - This exception gets 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.
    
    See Also:
    
    AWS API Documentation
  - adminInitiateAuth
```
public AdminInitiateAuthResult adminInitiateAuth(AdminInitiateAuthRequest adminInitiateAuthRequest)
```
    Initiates the authentication flow, as an administrator.
    
    Requires developer credentials.
    
    Specified by:
    
    adminInitiateAuth in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    adminInitiateAuthRequest - Initiates the authorization request, as an administrator.
    
    Returns:
    
    Result of the AdminInitiateAuth operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.
    
    UnexpectedLambdaException - This exception gets 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 gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
    
    InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - adminListDevices
```
public AdminListDevicesResult adminListDevices(AdminListDevicesRequest adminListDevicesRequest)
```
    Lists devices, as an administrator.
    
    Requires developer credentials.
    
    Specified by:
    
    adminListDevices in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    adminListDevicesRequest - Represents the request to list devices, as an administrator.
    
    Returns:
    
    Result of the AdminListDevices operation returned by the service.
    
    Throws:
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidUserPoolConfigurationException - This exception is thrown when the user pool configuration is invalid.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    See Also:
    
    AWS API Documentation
  - adminListGroupsForUser
```
public AdminListGroupsForUserResult adminListGroupsForUser(AdminListGroupsForUserRequest adminListGroupsForUserRequest)
```
    Lists the groups that the user belongs to.
    
    Requires developer credentials.
    
    Specified by:
    
    adminListGroupsForUser in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    adminListGroupsForUserRequest -
    
    Returns:
    
    Result of the AdminListGroupsForUser operation returned by the service.
    
    Throws:
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    NotAuthorizedException - This exception gets 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.
    
    See Also:
    
    AWS API Documentation
  - adminRemoveUserFromGroup
```
public AdminRemoveUserFromGroupResult adminRemoveUserFromGroup(AdminRemoveUserFromGroupRequest adminRemoveUserFromGroupRequest)
```
    Removes the specified user from the specified group.
    
    Requires developer credentials.
    
    Specified by:
    
    adminRemoveUserFromGroup in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    adminRemoveUserFromGroupRequest -
    
    Returns:
    
    Result of the AdminRemoveUserFromGroup operation returned by the service.
    
    Throws:
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    NotAuthorizedException - This exception gets 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.
    
    See Also:
    
    AWS API Documentation
  - adminResetUserPassword
```
public AdminResetUserPasswordResult adminResetUserPassword(AdminResetUserPasswordRequest adminResetUserPasswordRequest)
```
    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.
    
    Specified by:
    
    adminResetUserPassword in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    adminResetUserPasswordRequest - Represents the request to reset a user's password as an administrator.
    
    Returns:
    
    Result of the AdminResetUserPassword operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    UnexpectedLambdaException - This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.
    
    UserLambdaValidationException - This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    LimitExceededException - This exception is thrown when a user exceeds the limit for a requested AWS resource.
    
    UserNotFoundException - This exception is thrown when a user is not found.
    
    InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.
    
    See Also:
    
    AWS API Documentation
  - adminRespondToAuthChallenge
```
public AdminRespondToAuthChallengeResult adminRespondToAuthChallenge(AdminRespondToAuthChallengeRequest adminRespondToAuthChallengeRequest)
```
    Responds to an authentication challenge, as an administrator.
    
    Requires developer credentials.
    
    Specified by:
    
    adminRespondToAuthChallenge in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    adminRespondToAuthChallengeRequest - The request to respond to the authentication challenge, as an administrator.
    
    Returns:
    
    Result of the AdminRespondToAuthChallenge operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    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 gets 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 gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
    
    InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - adminSetUserSettings
```
public AdminSetUserSettingsResult adminSetUserSettings(AdminSetUserSettingsRequest adminSetUserSettingsRequest)
```
    Sets all the user settings for a specified user name. Works on any user.
    
    Requires developer credentials.
    
    Specified by:
    
    adminSetUserSettings in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    adminSetUserSettingsRequest - Represents the request to set user settings as an administrator.
    
    Returns:
    
    Result of the AdminSetUserSettings operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    UserNotFoundException - This exception is thrown when a user is not found.
    
    InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.
    
    See Also:
    
    AWS API Documentation
  - adminUpdateDeviceStatus
```
public AdminUpdateDeviceStatusResult adminUpdateDeviceStatus(AdminUpdateDeviceStatusRequest adminUpdateDeviceStatusRequest)
```
    Updates the device status as an administrator.
    
    Requires developer credentials.
    
    Specified by:
    
    adminUpdateDeviceStatus in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    adminUpdateDeviceStatusRequest - The request to update the device status, as an administrator.
    
    Returns:
    
    Result of the AdminUpdateDeviceStatus operation returned by the service.
    
    Throws:
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidUserPoolConfigurationException - This exception is thrown when the user pool configuration is invalid.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    UserNotFoundException - This exception is thrown when a user is not found.
    
    InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.
    
    See Also:
    
    AWS API Documentation
  - adminUpdateUserAttributes
```
public AdminUpdateUserAttributesResult adminUpdateUserAttributes(AdminUpdateUserAttributesRequest adminUpdateUserAttributesRequest)
```
    Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.
    
    Requires developer credentials.
    
    Specified by:
    
    adminUpdateUserAttributes in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    adminUpdateUserAttributesRequest - Represents the request to update the user's attributes as an administrator.
    
    Returns:
    
    Result of the AdminUpdateUserAttributes operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    UnexpectedLambdaException - This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.
    
    UserLambdaValidationException - This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
    
    InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
    
    AliasExistsException - This exception is thrown when a user tries to confirm the account with an email or phone number that has already been supplied as an alias from a different account. This exception tells user that an account with this email or phone already exists.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    NotAuthorizedException - This exception gets 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.
    
    See Also:
    
    AWS API Documentation
  - adminUserGlobalSignOut
```
public AdminUserGlobalSignOutResult adminUserGlobalSignOut(AdminUserGlobalSignOutRequest adminUserGlobalSignOutRequest)
```
    Signs out users from all devices, as an administrator.
    
    Requires developer credentials.
    
    Specified by:
    
    adminUserGlobalSignOut in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    adminUserGlobalSignOutRequest - The request to sign out of all devices, as an administrator.
    
    Returns:
    
    Result of the AdminUserGlobalSignOut operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    UserNotFoundException - This exception is thrown when a user is not found.
    
    InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.
    
    See Also:
    
    AWS API Documentation
  - changePassword
```
public ChangePasswordResult changePassword(ChangePasswordRequest changePasswordRequest)
```
    Changes the password for a specified user in a user pool.
    
    Specified by:
    
    changePassword in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    changePasswordRequest - Represents the request to change a user password.
    
    Returns:
    
    Result of the ChangePassword operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    InvalidPasswordException - This exception is thrown when the Amazon Cognito service encounters an invalid password.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - confirmDevice
```
public ConfirmDeviceResult confirmDevice(ConfirmDeviceRequest confirmDeviceRequest)
```
    Confirms tracking of the device. This API call is the call that beings device tracking.
    
    Specified by:
    
    confirmDevice in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    confirmDeviceRequest - Confirms the device request.
    
    Returns:
    
    Result of the ConfirmDevice operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    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 gets 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.
    
    See Also:
    
    AWS API Documentation
  - confirmForgotPassword
```
public ConfirmForgotPasswordResult confirmForgotPassword(ConfirmForgotPasswordRequest confirmForgotPasswordRequest)
```
    Allows a user to enter a code provided when they reset their password to update their password.
    
    Specified by:
    
    confirmForgotPassword in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    confirmForgotPasswordRequest - The request representing the confirmation for a password reset.
    
    Returns:
    
    Result of the ConfirmForgotPassword operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    UnexpectedLambdaException - This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.
    
    UserLambdaValidationException - This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    InvalidPasswordException - This exception is thrown when the Amazon Cognito service encounters an invalid password.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    CodeMismatchException - This exception is thrown if the provided code does not match what the server was expecting.
    
    ExpiredCodeException - This exception is thrown if a code has expired.
    
    TooManyFailedAttemptsException - This exception gets thrown when the user has made too many failed attempts for a given action (e.g., sign in).
    
    InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    LimitExceededException - This exception is thrown when a user exceeds the limit for a requested AWS resource.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - confirmSignUp
```
public ConfirmSignUpResult confirmSignUp(ConfirmSignUpRequest confirmSignUpRequest)
```
    Confirms registration of a user and handles the existing alias from a previous user.
    
    Specified by:
    
    confirmSignUp in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    confirmSignUpRequest - Represents the request to confirm registration of a user.
    
    Returns:
    
    Result of the ConfirmSignUp operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    UnexpectedLambdaException - This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.
    
    UserLambdaValidationException - This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    TooManyFailedAttemptsException - This exception gets thrown when the user has made too many failed attempts for a given action (e.g., sign in).
    
    CodeMismatchException - This exception is thrown if the provided code does not match what the server was expecting.
    
    ExpiredCodeException - This exception is thrown if a code has expired.
    
    InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
    
    AliasExistsException - This exception is thrown when a user tries to confirm the account with an email or phone number that has already been supplied as an alias from a different account. This exception tells user that an account with this email or phone already exists.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    LimitExceededException - This exception is thrown when a user exceeds the limit for a requested AWS resource.
    
    UserNotFoundException - This exception is thrown when a user is not found.
    
    InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.
    
    See Also:
    
    AWS API Documentation
  - createGroup
```
public CreateGroupResult createGroup(CreateGroupRequest createGroupRequest)
```
    Creates a new group in the specified user pool.
    
    Requires developer credentials.
    
    Specified by:
    
    createGroup in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    createGroupRequest -
    
    Returns:
    
    Result of the CreateGroup operation returned by the service.
    
    Throws:
    
    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 gets thrown when the user has made too many requests for a given operation.
    
    LimitExceededException - This exception is thrown when a user exceeds the limit for a requested AWS resource.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.
    
    See Also:
    
    AWS API Documentation
  - createUserImportJob
```
public CreateUserImportJobResult createUserImportJob(CreateUserImportJobRequest createUserImportJobRequest)
```
    Creates the user import job.
    
    Specified by:
    
    createUserImportJob in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    createUserImportJobRequest - Represents the request to create the user import job.
    
    Returns:
    
    Result of the CreateUserImportJob operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    PreconditionNotMetException - This exception is thrown when a precondition is not met.
    
    NotAuthorizedException - This exception gets 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.
    
    See Also:
    
    AWS API Documentation
  - createUserPool
```
public CreateUserPoolResult createUserPool(CreateUserPoolRequest createUserPoolRequest)
```
    Creates a new Amazon Cognito user pool and sets the password policy for the pool.
    
    Specified by:
    
    createUserPool in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    createUserPoolRequest - Represents the request to create a user pool.
    
    Returns:
    
    Result of the CreateUserPool operation returned by the service.
    
    Throws:
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    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 gets thrown when a user is not authorized.
    
    UserPoolTaggingException - This exception gets thrown when a user pool tag cannot be set or updated.
    
    InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.
    
    See Also:
    
    AWS API Documentation
  - createUserPoolClient
```
public CreateUserPoolClientResult createUserPoolClient(CreateUserPoolClientRequest createUserPoolClientRequest)
```
    Creates the user pool client.
    
    Specified by:
    
    createUserPoolClient in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    createUserPoolClientRequest - Represents the request to create a user pool client.
    
    Returns:
    
    Result of the CreateUserPoolClient operation returned by the service.
    
    Throws:
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    LimitExceededException - This exception is thrown when a user exceeds the limit for a requested AWS resource.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.
    
    See Also:
    
    AWS API Documentation
  - deleteGroup
```
public DeleteGroupResult deleteGroup(DeleteGroupRequest deleteGroupRequest)
```
    Deletes a group. Currently only groups with no members can be deleted.
    
    Requires developer credentials.
    
    Specified by:
    
    deleteGroup in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    deleteGroupRequest -
    
    Returns:
    
    Result of the DeleteGroup operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.
    
    See Also:
    
    AWS API Documentation
  - deleteUser
```
public DeleteUserResult deleteUser(DeleteUserRequest deleteUserRequest)
```
    Allows a user to delete one's self.
    
    Specified by:
    
    deleteUser in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    deleteUserRequest - Represents the request to delete a user.
    
    Returns:
    
    Result of the DeleteUser operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteUserAttributes
```
public DeleteUserAttributesResult deleteUserAttributes(DeleteUserAttributesRequest deleteUserAttributesRequest)
```
    Deletes the attributes for a user.
    
    Specified by:
    
    deleteUserAttributes in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    deleteUserAttributesRequest - Represents the request to delete user attributes.
    
    Returns:
    
    Result of the DeleteUserAttributes operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteUserPool
```
public DeleteUserPoolResult deleteUserPool(DeleteUserPoolRequest deleteUserPoolRequest)
```
    Deletes the specified Amazon Cognito user pool.
    
    Specified by:
    
    deleteUserPool in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    deleteUserPoolRequest - Represents the request to delete a user pool.
    
    Returns:
    
    Result of the DeleteUserPool operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    NotAuthorizedException - This exception gets 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.
    
    See Also:
    
    AWS API Documentation
  - deleteUserPoolClient
```
public DeleteUserPoolClientResult deleteUserPoolClient(DeleteUserPoolClientRequest deleteUserPoolClientRequest)
```
    Allows the developer to delete the user pool client.
    
    Specified by:
    
    deleteUserPoolClient in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    deleteUserPoolClientRequest - Represents the request to delete a user pool client.
    
    Returns:
    
    Result of the DeleteUserPoolClient operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.
    
    See Also:
    
    AWS API Documentation
  - describeUserImportJob
```
public DescribeUserImportJobResult describeUserImportJob(DescribeUserImportJobRequest describeUserImportJobRequest)
```
    Describes the user import job.
    
    Specified by:
    
    describeUserImportJob in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    describeUserImportJobRequest - Represents the request to describe the user import job.
    
    Returns:
    
    Result of the DescribeUserImportJob operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.
    
    See Also:
    
    AWS API Documentation
  - describeUserPool
```
public DescribeUserPoolResult describeUserPool(DescribeUserPoolRequest describeUserPoolRequest)
```
    Returns the configuration information and metadata of the specified user pool.
    
    Specified by:
    
    describeUserPool in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    describeUserPoolRequest - Represents the request to describe the user pool.
    
    Returns:
    
    Result of the DescribeUserPool operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    UserPoolTaggingException - This exception gets thrown when a user pool tag cannot be set or updated.
    
    InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.
    
    See Also:
    
    AWS API Documentation
  - describeUserPoolClient
```
public DescribeUserPoolClientResult describeUserPoolClient(DescribeUserPoolClientRequest describeUserPoolClientRequest)
```
    Client method for returning the configuration information and metadata of the specified user pool client.
    
    Specified by:
    
    describeUserPoolClient in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    describeUserPoolClientRequest - Represents the request to describe a user pool client.
    
    Returns:
    
    Result of the DescribeUserPoolClient operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.
    
    See Also:
    
    AWS API Documentation
  - forgetDevice
```
public ForgetDeviceResult forgetDevice(ForgetDeviceRequest forgetDeviceRequest)
```
    Forgets the specified device.
    
    Specified by:
    
    forgetDevice in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    forgetDeviceRequest - Represents the request to forget the device.
    
    Returns:
    
    Result of the ForgetDevice operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - forgotPassword
```
public ForgotPasswordResult forgotPassword(ForgotPasswordRequest forgotPasswordRequest)
```
    Retrieves the password for the specified client ID or username.
    
    Specified by:
    
    forgotPassword in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    forgotPasswordRequest - Represents the request to reset a user's password.
    
    Returns:
    
    Result of the ForgotPassword operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    UnexpectedLambdaException - This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.
    
    UserLambdaValidationException - This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    LimitExceededException - This exception is thrown when a user exceeds the limit for a requested AWS resource.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getCSVHeader
```
public GetCSVHeaderResult getCSVHeader(GetCSVHeaderRequest getCSVHeaderRequest)
```
    Gets the header information for the .csv file to be used as input for the user import job.
    
    Specified by:
    
    getCSVHeader in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    getCSVHeaderRequest - Represents the request to get the header information for the .csv file for the user import job.
    
    Returns:
    
    Result of the GetCSVHeader operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.
    
    See Also:
    
    AWS API Documentation
  - getDevice
```
public GetDeviceResult getDevice(GetDeviceRequest getDeviceRequest)
```
    Gets the device.
    
    Specified by:
    
    getDevice in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    getDeviceRequest - Represents the request to get the device.
    
    Returns:
    
    Result of the GetDevice operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    InvalidUserPoolConfigurationException - This exception is thrown when the user pool configuration is invalid.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getGroup
```
public GetGroupResult getGroup(GetGroupRequest getGroupRequest)
```
    Gets a group.
    
    Requires developer credentials.
    
    Specified by:
    
    getGroup in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    getGroupRequest -
    
    Returns:
    
    Result of the GetGroup operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.
    
    See Also:
    
    AWS API Documentation
  - getUser
```
public GetUserResult getUser(GetUserRequest getUserRequest)
```
    Gets the user attributes and metadata for a user.
    
    Specified by:
    
    getUser in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    getUserRequest - Represents the request to get information about the user.
    
    Returns:
    
    Result of the GetUser operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getUserAttributeVerificationCode
```
public GetUserAttributeVerificationCodeResult getUserAttributeVerificationCode(GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest)
```
    Gets the user attribute verification code for the specified attribute name.
    
    Specified by:
    
    getUserAttributeVerificationCode in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    getUserAttributeVerificationCodeRequest - Represents the request to get user attribute verification.
    
    Returns:
    
    Result of the GetUserAttributeVerificationCode operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    UnexpectedLambdaException - This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.
    
    UserLambdaValidationException - This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
    
    InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - globalSignOut
```
public GlobalSignOutResult globalSignOut(GlobalSignOutRequest globalSignOutRequest)
```
    Signs out users from all devices.
    
    Specified by:
    
    globalSignOut in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    globalSignOutRequest - Represents the request to sign out all devices.
    
    Returns:
    
    Result of the GlobalSignOut operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - initiateAuth
```
public InitiateAuthResult initiateAuth(InitiateAuthRequest initiateAuthRequest)
```
    Initiates the authentication flow.
    
    Specified by:
    
    initiateAuth in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    initiateAuthRequest - Initiates the authentication request.
    
    Returns:
    
    Result of the InitiateAuth operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    UnexpectedLambdaException - This exception gets 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 gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
    
    InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listDevices
```
public ListDevicesResult listDevices(ListDevicesRequest listDevicesRequest)
```
    Lists the devices.
    
    Specified by:
    
    listDevices in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    listDevicesRequest - Represents the request to list the devices.
    
    Returns:
    
    Result of the ListDevices operation returned by the service.
    
    Throws:
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    InvalidUserPoolConfigurationException - This exception is thrown when the user pool configuration is invalid.
    
    TooManyRequestsException - This exception gets 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.
    
    See Also:
    
    AWS API Documentation
  - listGroups
```
public ListGroupsResult listGroups(ListGroupsRequest listGroupsRequest)
```
    Lists the groups associated with a user pool.
    
    Requires developer credentials.
    
    Specified by:
    
    listGroups in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    listGroupsRequest -
    
    Returns:
    
    Result of the ListGroups operation returned by the service.
    
    Throws:
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.
    
    See Also:
    
    AWS API Documentation
  - listUserImportJobs
```
public ListUserImportJobsResult listUserImportJobs(ListUserImportJobsRequest listUserImportJobsRequest)
```
    Lists the user import jobs.
    
    Specified by:
    
    listUserImportJobs in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    listUserImportJobsRequest - Represents the request to list the user import jobs.
    
    Returns:
    
    Result of the ListUserImportJobs operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.
    
    See Also:
    
    AWS API Documentation
  - listUserPoolClients
```
public ListUserPoolClientsResult listUserPoolClients(ListUserPoolClientsRequest listUserPoolClientsRequest)
```
    Lists the clients that have been created for the specified user pool.
    
    Specified by:
    
    listUserPoolClients in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    listUserPoolClientsRequest - Represents the request to list the user pool clients.
    
    Returns:
    
    Result of the ListUserPoolClients operation returned by the service.
    
    Throws:
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.
    
    See Also:
    
    AWS API Documentation
  - listUserPools
```
public ListUserPoolsResult listUserPools(ListUserPoolsRequest listUserPoolsRequest)
```
    Lists the user pools associated with an AWS account.
    
    Specified by:
    
    listUserPools in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    listUserPoolsRequest - Represents the request to list user pools.
    
    Returns:
    
    Result of the ListUserPools operation returned by the service.
    
    Throws:
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.
    
    See Also:
    
    AWS API Documentation
  - listUsers
```
public ListUsersResult listUsers(ListUsersRequest listUsersRequest)
```
    Lists the users in the Amazon Cognito user pool.
    
    Specified by:
    
    listUsers in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    listUsersRequest - Represents the request to list users.
    
    Returns:
    
    Result of the ListUsers operation returned by the service.
    
    Throws:
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.
    
    See Also:
    
    AWS API Documentation
  - listUsersInGroup
```
public ListUsersInGroupResult listUsersInGroup(ListUsersInGroupRequest listUsersInGroupRequest)
```
    Lists the users in the specified group.
    
    Requires developer credentials.
    
    Specified by:
    
    listUsersInGroup in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    listUsersInGroupRequest -
    
    Returns:
    
    Result of the ListUsersInGroup operation returned by the service.
    
    Throws:
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.
    
    See Also:
    
    AWS API Documentation
  - resendConfirmationCode
```
public ResendConfirmationCodeResult resendConfirmationCode(ResendConfirmationCodeRequest resendConfirmationCodeRequest)
```
    Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
    
    Specified by:
    
    resendConfirmationCode in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    resendConfirmationCodeRequest - Represents the request to resend the confirmation code.
    
    Returns:
    
    Result of the ResendConfirmationCode operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    UnexpectedLambdaException - This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.
    
    UserLambdaValidationException - This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    LimitExceededException - This exception is thrown when a user exceeds the limit for a requested AWS resource.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - respondToAuthChallenge
```
public RespondToAuthChallengeResult respondToAuthChallenge(RespondToAuthChallengeRequest respondToAuthChallengeRequest)
```
    Responds to the authentication challenge.
    
    Specified by:
    
    respondToAuthChallenge in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    respondToAuthChallengeRequest - The request to respond to an authentication challenge.
    
    Returns:
    
    Result of the RespondToAuthChallenge operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    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 gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.
    
    UserLambdaValidationException - This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
    
    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 gets 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.
    
    See Also:
    
    AWS API Documentation
  - setUserSettings
```
public SetUserSettingsResult setUserSettings(SetUserSettingsRequest setUserSettingsRequest)
```
    Sets the user settings like multi-factor authentication (MFA). If MFA is to be removed for a particular attribute pass the attribute with code delivery as null. If null list is passed, all MFA options are removed.
    
    Specified by:
    
    setUserSettings in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    setUserSettingsRequest - Represents the request to set user settings.
    
    Returns:
    
    Result of the SetUserSettings operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - signUp
```
public SignUpResult signUp(SignUpRequest signUpRequest)
```
    Registers the user in the specified user pool and creates a user name, password, and user attributes.
    
    Specified by:
    
    signUp in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    signUpRequest - Represents the request to register a user.
    
    Returns:
    
    Result of the SignUp operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    UnexpectedLambdaException - This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.
    
    UserLambdaValidationException - This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    InvalidPasswordException - This exception is thrown when the Amazon Cognito service encounters an invalid password.
    
    InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
    
    UsernameExistsException - This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - startUserImportJob
```
public StartUserImportJobResult startUserImportJob(StartUserImportJobRequest startUserImportJobRequest)
```
    Starts the user import.
    
    Specified by:
    
    startUserImportJob in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    startUserImportJobRequest - Represents the request to start the user import job.
    
    Returns:
    
    Result of the StartUserImportJob operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.
    
    PreconditionNotMetException - This exception is thrown when a precondition is not met.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    See Also:
    
    AWS API Documentation
  - stopUserImportJob
```
public StopUserImportJobResult stopUserImportJob(StopUserImportJobRequest stopUserImportJobRequest)
```
    Stops the user import job.
    
    Specified by:
    
    stopUserImportJob in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    stopUserImportJobRequest - Represents the request to stop the user import job.
    
    Returns:
    
    Result of the StopUserImportJob operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.
    
    PreconditionNotMetException - This exception is thrown when a precondition is not met.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    See Also:
    
    AWS API Documentation
  - updateDeviceStatus
```
public UpdateDeviceStatusResult updateDeviceStatus(UpdateDeviceStatusRequest updateDeviceStatusRequest)
```
    Updates the device status.
    
    Specified by:
    
    updateDeviceStatus in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    updateDeviceStatusRequest - Represents the request to update the device status.
    
    Returns:
    
    Result of the UpdateDeviceStatus operation returned by the service.
    
    Throws:
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    InvalidUserPoolConfigurationException - This exception is thrown when the user pool configuration is invalid.
    
    TooManyRequestsException - This exception gets 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.
    
    See Also:
    
    AWS API Documentation
  - updateGroup
```
public UpdateGroupResult updateGroup(UpdateGroupRequest updateGroupRequest)
```
    Updates the specified group with the specified attributes.
    
    Requires developer credentials.
    
    Specified by:
    
    updateGroup in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    updateGroupRequest -
    
    Returns:
    
    Result of the UpdateGroup operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.
    
    See Also:
    
    AWS API Documentation
  - updateUserAttributes
```
public UpdateUserAttributesResult updateUserAttributes(UpdateUserAttributesRequest updateUserAttributesRequest)
```
    Allows a user to update a specific attribute (one at a time).
    
    Specified by:
    
    updateUserAttributes in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    updateUserAttributesRequest - Represents the request to update user attributes.
    
    Returns:
    
    Result of the UpdateUserAttributes operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    CodeMismatchException - This exception is thrown if the provided code does not match what the server was expecting.
    
    ExpiredCodeException - This exception is thrown if a code has expired.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    UnexpectedLambdaException - This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.
    
    UserLambdaValidationException - This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
    
    InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    AliasExistsException - This exception is thrown when a user tries to confirm the account with an email or phone number that has already been supplied as an alias from a different account. This exception tells user that an account with this email or phone already exists.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateUserPool
```
public UpdateUserPoolResult updateUserPool(UpdateUserPoolRequest updateUserPoolRequest)
```
    Updates the specified user pool with the specified attributes.
    
    Specified by:
    
    updateUserPool in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    updateUserPoolRequest - Represents the request to update the user pool.
    
    Returns:
    
    Result of the UpdateUserPool operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    ConcurrentModificationException - This exception is thrown if two or more modifications are happening concurrently.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    NotAuthorizedException - This exception gets 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 gets 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.
    
    See Also:
    
    AWS API Documentation
  - updateUserPoolClient
```
public UpdateUserPoolClientResult updateUserPoolClient(UpdateUserPoolClientRequest updateUserPoolClientRequest)
```
    Allows the developer to update the specified user pool client and password policy.
    
    Specified by:
    
    updateUserPoolClient in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    updateUserPoolClientRequest - Represents the request to update the user pool client.
    
    Returns:
    
    Result of the UpdateUserPoolClient operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.
    
    See Also:
    
    AWS API Documentation
  - verifyUserAttribute
```
public VerifyUserAttributeResult verifyUserAttribute(VerifyUserAttributeRequest verifyUserAttributeRequest)
```
    Verifies the specified user attributes in the user pool.
    
    Specified by:
    
    verifyUserAttribute in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    verifyUserAttributeRequest - Represents the request to verify user attributes.
    
    Returns:
    
    Result of the VerifyUserAttribute operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.
    
    InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
    
    CodeMismatchException - This exception is thrown if the provided code does not match what the server was expecting.
    
    ExpiredCodeException - This exception is thrown if a code has expired.
    
    NotAuthorizedException - This exception gets thrown when a user is not authorized.
    
    TooManyRequestsException - This exception gets thrown when the user has made too many requests for a given operation.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSCognitoIdentityProvider
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Class AWSCognitoIdentityProviderClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.cognitoidp.AWSCognitoIdentityProvider

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Methods inherited from interface com.amazonaws.services.cognitoidp.AWSCognitoIdentityProvider

Field Detail

configFactory

Constructor Detail

AWSCognitoIdentityProviderClient

AWSCognitoIdentityProviderClient

AWSCognitoIdentityProviderClient

AWSCognitoIdentityProviderClient

AWSCognitoIdentityProviderClient

AWSCognitoIdentityProviderClient

AWSCognitoIdentityProviderClient

Method Detail

builder

addCustomAttributes

adminAddUserToGroup

adminConfirmSignUp

adminCreateUser

adminDeleteUser

adminDeleteUserAttributes

adminDisableUser

adminEnableUser

adminForgetDevice

adminGetDevice

adminGetUser

adminInitiateAuth

adminListDevices

adminListGroupsForUser

adminRemoveUserFromGroup

adminResetUserPassword

adminRespondToAuthChallenge

adminSetUserSettings

adminUpdateDeviceStatus

adminUpdateUserAttributes

adminUserGlobalSignOut

changePassword

confirmDevice

confirmForgotPassword

confirmSignUp

createGroup

createUserImportJob

createUserPool

createUserPoolClient

deleteGroup

deleteUser

deleteUserAttributes

deleteUserPool

deleteUserPoolClient

describeUserImportJob

describeUserPool

describeUserPoolClient

forgetDevice

forgotPassword

getCSVHeader

getDevice

getGroup

getUser

getUserAttributeVerificationCode

globalSignOut

initiateAuth

listDevices

listGroups

listUserImportJobs

listUserPoolClients

listUserPools

listUsers

listUsersInGroup

resendConfirmationCode

respondToAuthChallenge

setUserSettings

signUp

startUserImportJob

stopUserImportJob