public class AmazonCognitoIdentityProviderClient extends AmazonWebServiceClient implements AmazonCognitoIdentityProvider
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.
| Modifier and Type | Field and Description |
|---|---|
protected List<com.amazonaws.transform.JsonErrorUnmarshaller> |
jsonErrorUnmarshallers
List of exception unmarshallers for all Amazon Cognito Your User Pool
exceptions.
|
client, clientConfiguration, endpoint, endpointPrefix, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset| Constructor and Description |
|---|
AmazonCognitoIdentityProviderClient()
Deprecated.
|
AmazonCognitoIdentityProviderClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on
AmazonCognitoIdentityProvider using the specified AWS account
credentials.
|
AmazonCognitoIdentityProviderClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonCognitoIdentityProvider using the specified AWS account credentials
and client configuration options.
|
AmazonCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on
AmazonCognitoIdentityProvider using the specified AWS account credentials
provider.
|
AmazonCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonCognitoIdentityProvider using the specified AWS account credentials
provider and client configuration options.
|
AmazonCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
HttpClient httpClient)
Constructs a new client to invoke service methods on
AmazonCognitoIdentityProvider using the specified AWS account credentials
provider, client configuration options and request metric collector.
|
AmazonCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
Deprecated.
|
AmazonCognitoIdentityProviderClient(ClientConfiguration clientConfiguration)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
AddCustomAttributesResult |
addCustomAttributes(AddCustomAttributesRequest addCustomAttributesRequest)
Adds additional user attributes to the user pool schema.
|
AdminConfirmSignUpResult |
adminConfirmSignUp(AdminConfirmSignUpRequest adminConfirmSignUpRequest)
Confirms user registration as an admin without using a confirmation code.
|
AdminCreateUserResult |
adminCreateUser(AdminCreateUserRequest adminCreateUserRequest)
Creates a new user in the specified user pool and sends a welcome message
via email or phone (SMS).
|
void |
adminForgetDevice(AdminForgetDeviceRequest adminForgetDeviceRequest)
Forgets the device, as an administrator.
|
AdminGetDeviceResult |
adminGetDevice(AdminGetDeviceRequest adminGetDeviceRequest)
Gets the device, as an administrator.
|
AdminInitiateAuthResult |
adminInitiateAuth(AdminInitiateAuthRequest adminInitiateAuthRequest)
Initiates the authentication flow, as an administrator.
|
AdminListDevicesResult |
adminListDevices(AdminListDevicesRequest adminListDevicesRequest)
Lists devices, 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.
|
AdminUserGlobalSignOutResult |
adminUserGlobalSignOut(AdminUserGlobalSignOutRequest adminUserGlobalSignOutRequest)
Signs out users from all devices, as an administrator.
|
AssociateSoftwareTokenResult |
associateSoftwareToken(AssociateSoftwareTokenRequest associateSoftwareTokenRequest) |
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.
|
CreateUserImportJobResult |
createUserImportJob(CreateUserImportJobRequest createUserImportJobRequest)
Creates the user import job.
|
CreateUserPoolClientResult |
createUserPoolClient(CreateUserPoolClientRequest createUserPoolClientRequest)
Creates the user pool client.
|
void |
deleteUser(DeleteUserRequest deleteUserRequest)
Allows a user to delete one's self.
|
DeleteUserAttributesResult |
deleteUserAttributes(DeleteUserAttributesRequest deleteUserAttributesRequest)
Deletes the attributes for a user.
|
void |
deleteUserPool(DeleteUserPoolRequest deleteUserPoolRequest)
Deletes the specified Amazon Cognito user pool.
|
void |
deleteUserPoolClient(DeleteUserPoolClientRequest deleteUserPoolClientRequest)
Allows the developer to delete the user pool client.
|
DescribeUserImportJobResult |
describeUserImportJob(DescribeUserImportJobRequest describeUserImportJobRequest)
Describes the user import job.
|
DescribeUserPoolClientResult |
describeUserPoolClient(DescribeUserPoolClientRequest describeUserPoolClientRequest)
Client method for returning the configuration information and metadata of
the specified user pool client.
|
void |
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)
Deprecated.
ResponseMetadata cache can hold up to 50 requests and
responses in memory and will cause memory issue. This method
now always returns null.
|
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.
|
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.
|
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.
|
ListUsersResult |
listUsers(ListUsersRequest listUsersRequest)
Lists the users in the Amazon Cognito user pool.
|
ResendConfirmationCodeResult |
resendConfirmationCode(ResendConfirmationCodeRequest resendConfirmationCodeRequest)
Resends the confirmation (for confirmation of registration) to a specific
user in the user pool.
|
RespondToAuthChallengeResult |
respondToAuthChallenge(RespondToAuthChallengeRequest respondToAuthChallengeRequest)
Responds to the authentication challenge.
|
SetUserMFAPreferenceResult |
setUserMFAPreference(SetUserMFAPreferenceRequest setUserMFAPreferenceRequest) |
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.
|
UpdateUserAttributesResult |
updateUserAttributes(UpdateUserAttributesRequest updateUserAttributesRequest)
Allows a user to update a specific attribute (one at a time).
|
UpdateUserPoolClientResult |
updateUserPoolClient(UpdateUserPoolClientRequest updateUserPoolClientRequest)
Allows the developer to update the specified user pool client and
password policy.
|
VerifySoftwareTokenResult |
verifySoftwareToken(VerifySoftwareTokenRequest verifySoftwareTokenRequest) |
VerifyUserAttributeResult |
verifyUserAttribute(VerifyUserAttributeRequest verifyUserAttributeRequest)
Verifies the specified user attributes in the user pool.
|
addRequestHandler, addRequestHandler, configSigner, configSigner, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpoint, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffsetclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion, shutdownprotected List<com.amazonaws.transform.JsonErrorUnmarshaller> jsonErrorUnmarshallers
@Deprecated public AmazonCognitoIdentityProviderClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AmazonCognitoIdentityProviderClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling
how this client connects to AmazonCognitoIdentityProvider (ex:
proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChainpublic AmazonCognitoIdentityProviderClient(AWSCredentials awsCredentials)
If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.
Automatically managed sessions will be shared among all clients that use
the same credentials and service endpoint. To opt out of this behavior,
explicitly provide an instance of AWSCredentialsProvider that
returns AWSSessionCredentials.
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key)
to use when authenticating with AWS services.public AmazonCognitoIdentityProviderClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.
Automatically managed sessions will be shared among all clients that use
the same credentials and service endpoint. To opt out of this behavior,
explicitly provide an instance of AWSCredentialsProvider that
returns AWSSessionCredentials.
All service calls made using this new client object are blocking, and will not return until the service call completes.
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 AmazonCognitoIdentityProvider (ex:
proxy settings, retry counts, etc.).public AmazonCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider)
If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.
Automatically managed sessions will be shared among all clients that use
the same credentials and service endpoint. To opt out of this behavior,
explicitly provide an instance of AWSCredentialsProvider that
returns AWSSessionCredentials.
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will
provide credentials to authenticate requests with AWS
services.public AmazonCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.
Automatically managed sessions will be shared among all clients that use
the same credentials and service endpoint. To opt out of this behavior,
explicitly provide an instance of AWSCredentialsProvider that
returns AWSSessionCredentials.
All service calls made using this new client object are blocking, and will not return until the service call completes.
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 AmazonCognitoIdentityProvider (ex:
proxy settings, retry counts, etc.).@Deprecated public AmazonCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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 AmazonCognitoIdentityProvider (ex:
proxy settings, retry counts, etc.).requestMetricCollector - optional request metric collectorpublic AmazonCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, HttpClient httpClient)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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 AmazonCognitoIdentityProvider (ex:
proxy settings, retry counts, etc.).httpClient - A http clientpublic AddCustomAttributesResult addCustomAttributes(AddCustomAttributesRequest addCustomAttributesRequest) throws AmazonServiceException, AmazonClientException
Adds additional user attributes to the user pool schema.
addCustomAttributes in interface AmazonCognitoIdentityProvideraddCustomAttributesRequest - Represents the request to add custom attributes.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserImportInProgressExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminConfirmSignUpResult adminConfirmSignUp(AdminConfirmSignUpRequest adminConfirmSignUpRequest) throws AmazonServiceException, AmazonClientException
Confirms user registration as an admin without using a confirmation code. Works on any user.
adminConfirmSignUp in interface AmazonCognitoIdentityProvideradminConfirmSignUpRequest - Represents the request to confirm user registration.
ResourceNotFoundExceptionInvalidParameterExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionNotAuthorizedExceptionTooManyFailedAttemptsExceptionInvalidLambdaResponseExceptionTooManyRequestsExceptionLimitExceededExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminCreateUserResult adminCreateUser(AdminCreateUserRequest adminCreateUserRequest) throws AmazonServiceException, AmazonClientException
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.
adminCreateUser in interface AmazonCognitoIdentityProvideradminCreateUserRequest - Represents the request to create a user in the specified user pool.
ResourceNotFoundExceptionInvalidParameterExceptionUserNotFoundExceptionUsernameExistsExceptionInvalidPasswordExceptionCodeDeliveryFailureExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionInvalidLambdaResponseExceptionPreconditionNotMetExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionTooManyRequestsExceptionNotAuthorizedExceptionUnsupportedUserStateExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public void adminForgetDevice(AdminForgetDeviceRequest adminForgetDeviceRequest) throws AmazonServiceException, AmazonClientException
Forgets the device, as an administrator.
adminForgetDevice in interface AmazonCognitoIdentityProvideradminForgetDeviceRequest - Sends the forgot device request, as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionInvalidUserPoolConfigurationExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminGetDeviceResult adminGetDevice(AdminGetDeviceRequest adminGetDeviceRequest) throws AmazonServiceException, AmazonClientException
Gets the device, as an administrator.
adminGetDevice in interface AmazonCognitoIdentityProvideradminGetDeviceRequest - Represents the request to get the device, as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionInvalidUserPoolConfigurationExceptionTooManyRequestsExceptionInternalErrorExceptionNotAuthorizedExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminInitiateAuthResult adminInitiateAuth(AdminInitiateAuthRequest adminInitiateAuthRequest) throws AmazonServiceException, AmazonClientException
Initiates the authentication flow, as an administrator.
adminInitiateAuth in interface AmazonCognitoIdentityProvideradminInitiateAuthRequest - Initiates the authorization request, as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionTooManyRequestsExceptionInternalErrorExceptionUnexpectedLambdaExceptionInvalidUserPoolConfigurationExceptionUserLambdaValidationExceptionInvalidLambdaResponseExceptionMFAMethodNotFoundExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminListDevicesResult adminListDevices(AdminListDevicesRequest adminListDevicesRequest) throws AmazonServiceException, AmazonClientException
Lists devices, as an administrator.
adminListDevices in interface AmazonCognitoIdentityProvideradminListDevicesRequest - Represents the request to list devices, as an administrator.
InvalidParameterExceptionResourceNotFoundExceptionInvalidUserPoolConfigurationExceptionTooManyRequestsExceptionInternalErrorExceptionNotAuthorizedExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminRespondToAuthChallengeResult adminRespondToAuthChallenge(AdminRespondToAuthChallengeRequest adminRespondToAuthChallengeRequest) throws AmazonServiceException, AmazonClientException
Responds to an authentication challenge, as an administrator.
adminRespondToAuthChallenge in interface AmazonCognitoIdentityProvideradminRespondToAuthChallengeRequest - The request to respond to the authentication challenge, as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionCodeMismatchExceptionExpiredCodeExceptionUnexpectedLambdaExceptionInvalidPasswordExceptionUserLambdaValidationExceptionInvalidLambdaResponseExceptionTooManyRequestsExceptionInvalidUserPoolConfigurationExceptionInternalErrorExceptionMFAMethodNotFoundExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionAliasExistsExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminSetUserSettingsResult adminSetUserSettings(AdminSetUserSettingsRequest adminSetUserSettingsRequest) throws AmazonServiceException, AmazonClientException
Sets all the user settings for a specified user name. Works on any user.
adminSetUserSettings in interface AmazonCognitoIdentityProvideradminSetUserSettingsRequest - Represents the request to set user settings as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminUpdateDeviceStatusResult adminUpdateDeviceStatus(AdminUpdateDeviceStatusRequest adminUpdateDeviceStatusRequest) throws AmazonServiceException, AmazonClientException
Updates the device status as an administrator.
adminUpdateDeviceStatus in interface AmazonCognitoIdentityProvideradminUpdateDeviceStatusRequest - The request to update the device status, as an administrator.
InvalidParameterExceptionResourceNotFoundExceptionInvalidUserPoolConfigurationExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AdminUserGlobalSignOutResult adminUserGlobalSignOut(AdminUserGlobalSignOutRequest adminUserGlobalSignOutRequest) throws AmazonServiceException, AmazonClientException
Signs out users from all devices, as an administrator.
adminUserGlobalSignOut in interface AmazonCognitoIdentityProvideradminUserGlobalSignOutRequest - The request to sign out of all devices, as an administrator.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public AssociateSoftwareTokenResult associateSoftwareToken(AssociateSoftwareTokenRequest associateSoftwareTokenRequest) throws AmazonServiceException, AmazonClientException
associateSoftwareToken in interface AmazonCognitoIdentityProviderassociateSoftwareTokenRequest - InvalidParameterExceptionNotAuthorizedExceptionResourceNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ChangePasswordResult changePassword(ChangePasswordRequest changePasswordRequest) throws AmazonServiceException, AmazonClientException
Changes the password for a specified user in a user pool.
changePassword in interface AmazonCognitoIdentityProviderchangePasswordRequest - Represents the request to change a user password.
ResourceNotFoundExceptionInvalidParameterExceptionInvalidPasswordExceptionNotAuthorizedExceptionTooManyRequestsExceptionLimitExceededExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ConfirmDeviceResult confirmDevice(ConfirmDeviceRequest confirmDeviceRequest) throws AmazonServiceException, AmazonClientException
Confirms tracking of the device. This API call is the call that beings device tracking.
confirmDevice in interface AmazonCognitoIdentityProviderconfirmDeviceRequest - Confirms the device request.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionInvalidPasswordExceptionInvalidLambdaResponseExceptionUsernameExistsExceptionInvalidUserPoolConfigurationExceptionTooManyRequestsExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ConfirmForgotPasswordResult confirmForgotPassword(ConfirmForgotPasswordRequest confirmForgotPasswordRequest) throws AmazonServiceException, AmazonClientException
Allows a user to enter a code provided when they reset their password to update their password.
confirmForgotPassword in interface AmazonCognitoIdentityProviderconfirmForgotPasswordRequest - The request representing the confirmation for a password reset.
ResourceNotFoundExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionInvalidParameterExceptionInvalidPasswordExceptionNotAuthorizedExceptionCodeMismatchExceptionExpiredCodeExceptionTooManyFailedAttemptsExceptionInvalidLambdaResponseExceptionTooManyRequestsExceptionLimitExceededExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ConfirmSignUpResult confirmSignUp(ConfirmSignUpRequest confirmSignUpRequest) throws AmazonServiceException, AmazonClientException
Confirms registration of a user and handles the existing alias from a previous user.
confirmSignUp in interface AmazonCognitoIdentityProviderconfirmSignUpRequest - Represents the request to confirm registration of a user.
ResourceNotFoundExceptionInvalidParameterExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionNotAuthorizedExceptionTooManyFailedAttemptsExceptionCodeMismatchExceptionExpiredCodeExceptionInvalidLambdaResponseExceptionAliasExistsExceptionTooManyRequestsExceptionLimitExceededExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public CreateUserImportJobResult createUserImportJob(CreateUserImportJobRequest createUserImportJobRequest) throws AmazonServiceException, AmazonClientException
Creates the user import job.
createUserImportJob in interface AmazonCognitoIdentityProvidercreateUserImportJobRequest - Represents the request to create the user import job.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionPreconditionNotMetExceptionNotAuthorizedExceptionLimitExceededExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public CreateUserPoolClientResult createUserPoolClient(CreateUserPoolClientRequest createUserPoolClientRequest) throws AmazonServiceException, AmazonClientException
Creates the user pool client.
createUserPoolClient in interface AmazonCognitoIdentityProvidercreateUserPoolClientRequest - Represents the request to create a user pool client.
InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionLimitExceededExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public void deleteUser(DeleteUserRequest deleteUserRequest) throws AmazonServiceException, AmazonClientException
Allows a user to delete one's self.
deleteUser in interface AmazonCognitoIdentityProviderdeleteUserRequest - Represents the request to delete a user.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionTooManyRequestsExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public DeleteUserAttributesResult deleteUserAttributes(DeleteUserAttributesRequest deleteUserAttributesRequest) throws AmazonServiceException, AmazonClientException
Deletes the attributes for a user.
deleteUserAttributes in interface AmazonCognitoIdentityProviderdeleteUserAttributesRequest - Represents the request to delete user attributes.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionTooManyRequestsExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public void deleteUserPool(DeleteUserPoolRequest deleteUserPoolRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified Amazon Cognito user pool.
deleteUserPool in interface AmazonCognitoIdentityProviderdeleteUserPoolRequest - Represents the request to delete a user pool.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUserImportInProgressExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public void deleteUserPoolClient(DeleteUserPoolClientRequest deleteUserPoolClientRequest) throws AmazonServiceException, AmazonClientException
Allows the developer to delete the user pool client.
deleteUserPoolClient in interface AmazonCognitoIdentityProviderdeleteUserPoolClientRequest - Represents the request to delete a user pool client.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public DescribeUserImportJobResult describeUserImportJob(DescribeUserImportJobRequest describeUserImportJobRequest) throws AmazonServiceException, AmazonClientException
Describes the user import job.
describeUserImportJob in interface AmazonCognitoIdentityProviderdescribeUserImportJobRequest - Represents the request to describe the user import job.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public DescribeUserPoolClientResult describeUserPoolClient(DescribeUserPoolClientRequest describeUserPoolClientRequest) throws AmazonServiceException, AmazonClientException
Client method for returning the configuration information and metadata of the specified user pool client.
describeUserPoolClient in interface AmazonCognitoIdentityProviderdescribeUserPoolClientRequest - Represents the request to describe a user pool client.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public void forgetDevice(ForgetDeviceRequest forgetDeviceRequest) throws AmazonServiceException, AmazonClientException
Forgets the specified device.
forgetDevice in interface AmazonCognitoIdentityProviderforgetDeviceRequest - Represents the request to forget the device.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionTooManyRequestsExceptionInvalidUserPoolConfigurationExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ForgotPasswordResult forgotPassword(ForgotPasswordRequest forgotPasswordRequest) throws AmazonServiceException, AmazonClientException
Retrieves the password for the specified client ID or username.
forgotPassword in interface AmazonCognitoIdentityProviderforgotPasswordRequest - Represents the request to reset a user's password.
ResourceNotFoundExceptionInvalidParameterExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionNotAuthorizedExceptionInvalidLambdaResponseExceptionTooManyRequestsExceptionLimitExceededExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionInvalidEmailRoleAccessPolicyExceptionCodeDeliveryFailureExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public GetCSVHeaderResult getCSVHeader(GetCSVHeaderRequest getCSVHeaderRequest) throws AmazonServiceException, AmazonClientException
Gets the header information for the .csv file to be used as input for the user import job.
getCSVHeader in interface AmazonCognitoIdentityProvidergetCSVHeaderRequest - Represents the request to get the header information for the .csv file for the user import job.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public GetDeviceResult getDevice(GetDeviceRequest getDeviceRequest) throws AmazonServiceException, AmazonClientException
Gets the device.
getDevice in interface AmazonCognitoIdentityProvidergetDeviceRequest - Represents the request to get the device.
ResourceNotFoundExceptionInvalidParameterExceptionInvalidUserPoolConfigurationExceptionNotAuthorizedExceptionTooManyRequestsExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public GetUserResult getUser(GetUserRequest getUserRequest) throws AmazonServiceException, AmazonClientException
Gets the user attributes and metadata for a user.
getUser in interface AmazonCognitoIdentityProvidergetUserRequest - Represents the request to get information about the user.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionTooManyRequestsExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public GetUserAttributeVerificationCodeResult getUserAttributeVerificationCode(GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest) throws AmazonServiceException, AmazonClientException
Gets the user attribute verification code for the specified attribute name.
getUserAttributeVerificationCode in interface AmazonCognitoIdentityProvidergetUserAttributeVerificationCodeRequest - Represents the request to get user attribute verification.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionInvalidLambdaResponseExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionInvalidEmailRoleAccessPolicyExceptionCodeDeliveryFailureExceptionLimitExceededExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public GlobalSignOutResult globalSignOut(GlobalSignOutRequest globalSignOutRequest) throws AmazonServiceException, AmazonClientException
Signs out users from all devices.
globalSignOut in interface AmazonCognitoIdentityProviderglobalSignOutRequest - Represents the request to sign out all devices.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionTooManyRequestsExceptionPasswordResetRequiredExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public InitiateAuthResult initiateAuth(InitiateAuthRequest initiateAuthRequest) throws AmazonServiceException, AmazonClientException
Initiates the authentication flow.
initiateAuth in interface AmazonCognitoIdentityProviderinitiateAuthRequest - Initiates the authentication request.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionTooManyRequestsExceptionUnexpectedLambdaExceptionInvalidUserPoolConfigurationExceptionUserLambdaValidationExceptionInvalidLambdaResponseExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ListDevicesResult listDevices(ListDevicesRequest listDevicesRequest) throws AmazonServiceException, AmazonClientException
Lists the devices.
listDevices in interface AmazonCognitoIdentityProviderlistDevicesRequest - Represents the request to list the devices.
InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionInvalidUserPoolConfigurationExceptionTooManyRequestsExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ListUserImportJobsResult listUserImportJobs(ListUserImportJobsRequest listUserImportJobsRequest) throws AmazonServiceException, AmazonClientException
Lists the user import jobs.
listUserImportJobs in interface AmazonCognitoIdentityProviderlistUserImportJobsRequest - Represents the request to list the user import jobs.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ListUserPoolClientsResult listUserPoolClients(ListUserPoolClientsRequest listUserPoolClientsRequest) throws AmazonServiceException, AmazonClientException
Lists the clients that have been created for the specified user pool.
listUserPoolClients in interface AmazonCognitoIdentityProviderlistUserPoolClientsRequest - Represents the request to list the user pool clients.
InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ListUsersResult listUsers(ListUsersRequest listUsersRequest) throws AmazonServiceException, AmazonClientException
Lists the users in the Amazon Cognito user pool.
listUsers in interface AmazonCognitoIdentityProviderlistUsersRequest - Represents the request to list users.
InvalidParameterExceptionResourceNotFoundExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public ResendConfirmationCodeResult resendConfirmationCode(ResendConfirmationCodeRequest resendConfirmationCodeRequest) throws AmazonServiceException, AmazonClientException
Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
resendConfirmationCode in interface AmazonCognitoIdentityProviderresendConfirmationCodeRequest - Represents the request to resend the confirmation code.
ResourceNotFoundExceptionInvalidParameterExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionNotAuthorizedExceptionInvalidLambdaResponseExceptionTooManyRequestsExceptionLimitExceededExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionInvalidEmailRoleAccessPolicyExceptionCodeDeliveryFailureExceptionUserNotFoundExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public RespondToAuthChallengeResult respondToAuthChallenge(RespondToAuthChallengeRequest respondToAuthChallengeRequest) throws AmazonServiceException, AmazonClientException
Responds to the authentication challenge.
respondToAuthChallenge in interface AmazonCognitoIdentityProviderrespondToAuthChallengeRequest - The request to respond to an authentication challenge.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionCodeMismatchExceptionExpiredCodeExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionInvalidPasswordExceptionInvalidLambdaResponseExceptionTooManyRequestsExceptionInvalidUserPoolConfigurationExceptionMFAMethodNotFoundExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionAliasExistsExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public SetUserMFAPreferenceResult setUserMFAPreference(SetUserMFAPreferenceRequest setUserMFAPreferenceRequest) throws AmazonServiceException, AmazonClientException
setUserMFAPreference in interface AmazonCognitoIdentityProvidersetUserMFAPreferenceRequest - ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public SetUserSettingsResult setUserSettings(SetUserSettingsRequest setUserSettingsRequest) throws AmazonServiceException, AmazonClientException
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.
setUserSettings in interface AmazonCognitoIdentityProvidersetUserSettingsRequest - Represents the request to set user settings.
ResourceNotFoundExceptionInvalidParameterExceptionNotAuthorizedExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public SignUpResult signUp(SignUpRequest signUpRequest) throws AmazonServiceException, AmazonClientException
Registers the user in the specified user pool and creates a user name, password, and user attributes.
signUp in interface AmazonCognitoIdentityProvidersignUpRequest - Represents the request to register a user.
ResourceNotFoundExceptionInvalidParameterExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionNotAuthorizedExceptionInvalidPasswordExceptionInvalidLambdaResponseExceptionUsernameExistsExceptionTooManyRequestsExceptionInternalErrorExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionInvalidEmailRoleAccessPolicyExceptionCodeDeliveryFailureExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public StartUserImportJobResult startUserImportJob(StartUserImportJobRequest startUserImportJobRequest) throws AmazonServiceException, AmazonClientException
Starts the user import.
startUserImportJob in interface AmazonCognitoIdentityProviderstartUserImportJobRequest - Represents the request to start the user import job.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionInternalErrorExceptionPreconditionNotMetExceptionNotAuthorizedExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public StopUserImportJobResult stopUserImportJob(StopUserImportJobRequest stopUserImportJobRequest) throws AmazonServiceException, AmazonClientException
Stops the user import job.
stopUserImportJob in interface AmazonCognitoIdentityProviderstopUserImportJobRequest - Represents the request to stop the user import job.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionInternalErrorExceptionPreconditionNotMetExceptionNotAuthorizedExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public UpdateDeviceStatusResult updateDeviceStatus(UpdateDeviceStatusRequest updateDeviceStatusRequest) throws AmazonServiceException, AmazonClientException
Updates the device status.
updateDeviceStatus in interface AmazonCognitoIdentityProviderupdateDeviceStatusRequest - Represents the request to update the device status.
InvalidParameterExceptionResourceNotFoundExceptionNotAuthorizedExceptionInvalidUserPoolConfigurationExceptionTooManyRequestsExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public UpdateUserAttributesResult updateUserAttributes(UpdateUserAttributesRequest updateUserAttributesRequest) throws AmazonServiceException, AmazonClientException
Allows a user to update a specific attribute (one at a time).
updateUserAttributes in interface AmazonCognitoIdentityProviderupdateUserAttributesRequest - Represents the request to update user attributes.
ResourceNotFoundExceptionInvalidParameterExceptionCodeMismatchExceptionExpiredCodeExceptionNotAuthorizedExceptionUnexpectedLambdaExceptionUserLambdaValidationExceptionInvalidLambdaResponseExceptionTooManyRequestsExceptionAliasExistsExceptionInvalidSmsRoleAccessPolicyExceptionInvalidSmsRoleTrustRelationshipExceptionInvalidEmailRoleAccessPolicyExceptionCodeDeliveryFailureExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public UpdateUserPoolClientResult updateUserPoolClient(UpdateUserPoolClientRequest updateUserPoolClientRequest) throws AmazonServiceException, AmazonClientException
Allows the developer to update the specified user pool client and password policy.
updateUserPoolClient in interface AmazonCognitoIdentityProviderupdateUserPoolClientRequest - Represents the request to update the user pool client.
ResourceNotFoundExceptionInvalidParameterExceptionTooManyRequestsExceptionNotAuthorizedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public VerifySoftwareTokenResult verifySoftwareToken(VerifySoftwareTokenRequest verifySoftwareTokenRequest) throws AmazonServiceException, AmazonClientException
verifySoftwareToken in interface AmazonCognitoIdentityProviderverifySoftwareTokenRequest - ResourceNotFoundExceptionInvalidParameterExceptionInvalidUserPoolConfigurationExceptionEnableSoftwareTokenMFAExceptionSoftwareTokenMFANotFoundExceptionCodeMismatchExceptionExpiredCodeExceptionNotAuthorizedExceptionTooManyRequestsExceptionLimitExceededExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.public VerifyUserAttributeResult verifyUserAttribute(VerifyUserAttributeRequest verifyUserAttributeRequest) throws AmazonServiceException, AmazonClientException
Verifies the specified user attributes in the user pool.
verifyUserAttribute in interface AmazonCognitoIdentityProviderverifyUserAttributeRequest - Represents the request to verify user attributes.
ResourceNotFoundExceptionInvalidParameterExceptionCodeMismatchExceptionExpiredCodeExceptionNotAuthorizedExceptionTooManyRequestsExceptionLimitExceededExceptionPasswordResetRequiredExceptionUserNotFoundExceptionUserNotConfirmedExceptionInternalErrorExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Cognito Your User Pool indicating either a problem with the
data in the request, or a server side issue.@Deprecated public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata in interface AmazonCognitoIdentityProviderrequest - The originally executed requestCopyright © 2018. All rights reserved.