@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSCognitoIdentityProviderClient extends AmazonWebServiceClient implements AWSCognitoIdentityProvider
Using the Amazon Cognito User Pools API, you can create a user pool to manage directories and users. You can authenticate a user to obtain tokens related to user identity and access policies.
This API reference provides information about user pools in Amazon Cognito User Pools.
For more information, see the Amazon Cognito Documentation.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Constructor and Description |
---|
AWSCognitoIdentityProviderClient()
Deprecated.
|
AWSCognitoIdentityProviderClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for
example:
AWSCognitoIdentityProviderClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AWSCognitoIdentityProviderClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AWSCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AWSCognitoIdentityProviderClient(ClientConfiguration clientConfiguration)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
AddCustomAttributesResult |
addCustomAttributes(AddCustomAttributesRequest request)
Adds additional user attributes to the user pool schema.
|
AdminAddUserToGroupResult |
adminAddUserToGroup(AdminAddUserToGroupRequest request)
Adds the specified user to the specified group.
|
AdminConfirmSignUpResult |
adminConfirmSignUp(AdminConfirmSignUpRequest request)
Confirms user registration as an admin without using a confirmation code.
|
AdminCreateUserResult |
adminCreateUser(AdminCreateUserRequest request)
Creates a new user in the specified user pool and sends a welcome message via email or phone (SMS).
|
AdminDeleteUserResult |
adminDeleteUser(AdminDeleteUserRequest request)
Deletes a user as an administrator.
|
AdminDeleteUserAttributesResult |
adminDeleteUserAttributes(AdminDeleteUserAttributesRequest request)
Deletes the user attributes in a user pool as an administrator.
|
AdminDisableProviderForUserResult |
adminDisableProviderForUser(AdminDisableProviderForUserRequest request)
Disables the user from signing in with the specified external (SAML or social) identity provider.
|
AdminDisableUserResult |
adminDisableUser(AdminDisableUserRequest request)
Disables the specified user as an administrator.
|
AdminEnableUserResult |
adminEnableUser(AdminEnableUserRequest request)
Enables the specified user as an administrator.
|
AdminForgetDeviceResult |
adminForgetDevice(AdminForgetDeviceRequest request)
Forgets the device, as an administrator.
|
AdminGetDeviceResult |
adminGetDevice(AdminGetDeviceRequest request)
Gets the device, as an administrator.
|
AdminGetUserResult |
adminGetUser(AdminGetUserRequest request)
Gets the specified user by user name in a user pool as an administrator.
|
AdminInitiateAuthResult |
adminInitiateAuth(AdminInitiateAuthRequest request)
Initiates the authentication flow, as an administrator.
|
AdminLinkProviderForUserResult |
adminLinkProviderForUser(AdminLinkProviderForUserRequest request)
Links an existing user account in a user pool (
DestinationUser ) to an identity from an external
identity provider (SourceUser ) based on a specified attribute name and value from the external
identity provider. |
AdminListDevicesResult |
adminListDevices(AdminListDevicesRequest request)
Lists devices, as an administrator.
|
AdminListGroupsForUserResult |
adminListGroupsForUser(AdminListGroupsForUserRequest request)
Lists the groups that the user belongs to.
|
AdminRemoveUserFromGroupResult |
adminRemoveUserFromGroup(AdminRemoveUserFromGroupRequest request)
Removes the specified user from the specified group.
|
AdminResetUserPasswordResult |
adminResetUserPassword(AdminResetUserPasswordRequest request)
Resets the specified user's password in a user pool as an administrator.
|
AdminRespondToAuthChallengeResult |
adminRespondToAuthChallenge(AdminRespondToAuthChallengeRequest request)
Responds to an authentication challenge, as an administrator.
|
AdminSetUserSettingsResult |
adminSetUserSettings(AdminSetUserSettingsRequest request)
Sets all the user settings for a specified user name.
|
AdminUpdateDeviceStatusResult |
adminUpdateDeviceStatus(AdminUpdateDeviceStatusRequest request)
Updates the device status as an administrator.
|
AdminUpdateUserAttributesResult |
adminUpdateUserAttributes(AdminUpdateUserAttributesRequest request)
Updates the specified user's attributes, including developer attributes, as an administrator.
|
AdminUserGlobalSignOutResult |
adminUserGlobalSignOut(AdminUserGlobalSignOutRequest request)
Signs out users from all devices, as an administrator.
|
static AWSCognitoIdentityProviderClientBuilder |
builder() |
ChangePasswordResult |
changePassword(ChangePasswordRequest request)
Changes the password for a specified user in a user pool.
|
ConfirmDeviceResult |
confirmDevice(ConfirmDeviceRequest request)
Confirms tracking of the device.
|
ConfirmForgotPasswordResult |
confirmForgotPassword(ConfirmForgotPasswordRequest request)
Allows a user to enter a confirmation code to reset a forgotten password.
|
ConfirmSignUpResult |
confirmSignUp(ConfirmSignUpRequest request)
Confirms registration of a user and handles the existing alias from a previous user.
|
CreateGroupResult |
createGroup(CreateGroupRequest request)
Creates a new group in the specified user pool.
|
CreateIdentityProviderResult |
createIdentityProvider(CreateIdentityProviderRequest request)
Creates an identity provider for a user pool.
|
CreateResourceServerResult |
createResourceServer(CreateResourceServerRequest request)
Creates a new OAuth2.0 resource server and defines custom scopes in it.
|
CreateUserImportJobResult |
createUserImportJob(CreateUserImportJobRequest request)
Creates the user import job.
|
CreateUserPoolResult |
createUserPool(CreateUserPoolRequest request)
Creates a new Amazon Cognito user pool and sets the password policy for the pool.
|
CreateUserPoolClientResult |
createUserPoolClient(CreateUserPoolClientRequest request)
Creates the user pool client.
|
CreateUserPoolDomainResult |
createUserPoolDomain(CreateUserPoolDomainRequest request)
Creates a new domain for a user pool.
|
DeleteGroupResult |
deleteGroup(DeleteGroupRequest request)
Deletes a group.
|
DeleteIdentityProviderResult |
deleteIdentityProvider(DeleteIdentityProviderRequest request)
Deletes an identity provider for a user pool.
|
DeleteResourceServerResult |
deleteResourceServer(DeleteResourceServerRequest request)
Deletes a resource server.
|
DeleteUserResult |
deleteUser(DeleteUserRequest request)
Allows a user to delete himself or herself.
|
DeleteUserAttributesResult |
deleteUserAttributes(DeleteUserAttributesRequest request)
Deletes the attributes for a user.
|
DeleteUserPoolResult |
deleteUserPool(DeleteUserPoolRequest request)
Deletes the specified Amazon Cognito user pool.
|
DeleteUserPoolClientResult |
deleteUserPoolClient(DeleteUserPoolClientRequest request)
Allows the developer to delete the user pool client.
|
DeleteUserPoolDomainResult |
deleteUserPoolDomain(DeleteUserPoolDomainRequest request)
Deletes a domain for a user pool.
|
DescribeIdentityProviderResult |
describeIdentityProvider(DescribeIdentityProviderRequest request)
Gets information about a specific identity provider.
|
DescribeResourceServerResult |
describeResourceServer(DescribeResourceServerRequest request)
Describes a resource server.
|
DescribeUserImportJobResult |
describeUserImportJob(DescribeUserImportJobRequest request)
Describes the user import job.
|
DescribeUserPoolResult |
describeUserPool(DescribeUserPoolRequest request)
Returns the configuration information and metadata of the specified user pool.
|
DescribeUserPoolClientResult |
describeUserPoolClient(DescribeUserPoolClientRequest request)
Client method for returning the configuration information and metadata of the specified user pool client.
|
DescribeUserPoolDomainResult |
describeUserPoolDomain(DescribeUserPoolDomainRequest request)
Gets information about a domain.
|
ForgetDeviceResult |
forgetDevice(ForgetDeviceRequest request)
Forgets the specified device.
|
ForgotPasswordResult |
forgotPassword(ForgotPasswordRequest request)
Calling this API causes a message to be sent to the end user with a confirmation code that is required to change
the user's password.
|
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 request)
Gets the header information for the .csv file to be used as input for the user import job.
|
GetDeviceResult |
getDevice(GetDeviceRequest request)
Gets the device.
|
GetGroupResult |
getGroup(GetGroupRequest request)
Gets a group.
|
GetIdentityProviderByIdentifierResult |
getIdentityProviderByIdentifier(GetIdentityProviderByIdentifierRequest request)
Gets the specified identity provider.
|
GetUICustomizationResult |
getUICustomization(GetUICustomizationRequest request)
Gets the UI Customization information for a particular app client's app UI, if there is something set.
|
GetUserResult |
getUser(GetUserRequest request)
Gets the user attributes and metadata for a user.
|
GetUserAttributeVerificationCodeResult |
getUserAttributeVerificationCode(GetUserAttributeVerificationCodeRequest request)
Gets the user attribute verification code for the specified attribute name.
|
GlobalSignOutResult |
globalSignOut(GlobalSignOutRequest request)
Signs out users from all devices.
|
InitiateAuthResult |
initiateAuth(InitiateAuthRequest request)
Initiates the authentication flow.
|
ListDevicesResult |
listDevices(ListDevicesRequest request)
Lists the devices.
|
ListGroupsResult |
listGroups(ListGroupsRequest request)
Lists the groups associated with a user pool.
|
ListIdentityProvidersResult |
listIdentityProviders(ListIdentityProvidersRequest request)
Lists information about all identity providers for a user pool.
|
ListResourceServersResult |
listResourceServers(ListResourceServersRequest request)
Lists the resource servers for a user pool.
|
ListUserImportJobsResult |
listUserImportJobs(ListUserImportJobsRequest request)
Lists the user import jobs.
|
ListUserPoolClientsResult |
listUserPoolClients(ListUserPoolClientsRequest request)
Lists the clients that have been created for the specified user pool.
|
ListUserPoolsResult |
listUserPools(ListUserPoolsRequest request)
Lists the user pools associated with an AWS account.
|
ListUsersResult |
listUsers(ListUsersRequest request)
Lists the users in the Amazon Cognito user pool.
|
ListUsersInGroupResult |
listUsersInGroup(ListUsersInGroupRequest request)
Lists the users in the specified group.
|
ResendConfirmationCodeResult |
resendConfirmationCode(ResendConfirmationCodeRequest request)
Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
|
RespondToAuthChallengeResult |
respondToAuthChallenge(RespondToAuthChallengeRequest request)
Responds to the authentication challenge.
|
SetUICustomizationResult |
setUICustomization(SetUICustomizationRequest request)
Sets the UI customization information for a user pool's built-in app UI.
|
SetUserSettingsResult |
setUserSettings(SetUserSettingsRequest request)
Sets the user settings like multi-factor authentication (MFA).
|
SignUpResult |
signUp(SignUpRequest request)
Registers the user in the specified user pool and creates a user name, password, and user attributes.
|
StartUserImportJobResult |
startUserImportJob(StartUserImportJobRequest request)
Starts the user import.
|
StopUserImportJobResult |
stopUserImportJob(StopUserImportJobRequest request)
Stops the user import job.
|
UpdateDeviceStatusResult |
updateDeviceStatus(UpdateDeviceStatusRequest request)
Updates the device status.
|
UpdateGroupResult |
updateGroup(UpdateGroupRequest request)
Updates the specified group with the specified attributes.
|
UpdateIdentityProviderResult |
updateIdentityProvider(UpdateIdentityProviderRequest request)
Updates identity provider information for a user pool.
|
UpdateResourceServerResult |
updateResourceServer(UpdateResourceServerRequest request)
Updates the name and scopes of resource server.
|
UpdateUserAttributesResult |
updateUserAttributes(UpdateUserAttributesRequest request)
Allows a user to update a specific attribute (one at a time).
|
UpdateUserPoolResult |
updateUserPool(UpdateUserPoolRequest request)
Updates the specified user pool with the specified attributes.
|
UpdateUserPoolClientResult |
updateUserPoolClient(UpdateUserPoolClientRequest request)
Allows the developer to update the specified user pool client and password policy.
|
VerifyUserAttributeResult |
verifyUserAttribute(VerifyUserAttributeRequest request)
Verifies the specified user attributes in the user pool.
|
addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion, shutdown
@Deprecated public AWSCognitoIdentityProviderClient()
AWSCognitoIdentityProviderClientBuilder.defaultClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
@Deprecated public AWSCognitoIdentityProviderClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(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 Amazon Cognito Identity Provider
(ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChain
@Deprecated public AWSCognitoIdentityProviderClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
for
example:
AWSCognitoIdentityProviderClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
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.@Deprecated public AWSCognitoIdentityProviderClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
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 Amazon Cognito Identity Provider
(ex: proxy settings, retry counts, etc.).@Deprecated public AWSCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
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.@Deprecated public AWSCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
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 Amazon Cognito Identity Provider
(ex: proxy settings, retry counts, etc.).@Deprecated public AWSCognitoIdentityProviderClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsClientBuilder.withMetricsCollector(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 Amazon Cognito Identity Provider
(ex: proxy settings, retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic static AWSCognitoIdentityProviderClientBuilder builder()
public AddCustomAttributesResult addCustomAttributes(AddCustomAttributesRequest request)
Adds additional user attributes to the user pool schema.
addCustomAttributes
in interface AWSCognitoIdentityProvider
addCustomAttributesRequest
- Represents the request to add custom attributes.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserImportInProgressException
- This exception is thrown when you are trying to modify a user pool while a user import job is in progress
for that pool.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public AdminAddUserToGroupResult adminAddUserToGroup(AdminAddUserToGroupRequest request)
Adds the specified user to the specified group.
Requires developer credentials.
adminAddUserToGroup
in interface AWSCognitoIdentityProvider
adminAddUserToGroupRequest
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public AdminConfirmSignUpResult adminConfirmSignUp(AdminConfirmSignUpRequest request)
Confirms user registration as an admin without using a confirmation code. Works on any user.
Requires developer credentials.
adminConfirmSignUp
in interface AWSCognitoIdentityProvider
adminConfirmSignUpRequest
- Represents the request to confirm user registration.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyFailedAttemptsException
- This exception is thrown when the user has made too many failed attempts for a given action (e.g., sign
in).InvalidLambdaResponseException
- This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public AdminCreateUserResult adminCreateUser(AdminCreateUserRequest request)
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 AWSCognitoIdentityProvider
adminCreateUserRequest
- Represents the request to create a user in the specified user pool.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UserNotFoundException
- This exception is thrown when a user is not found.UsernameExistsException
- This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.InvalidPasswordException
- This exception is thrown when the Amazon Cognito service encounters an invalid password.CodeDeliveryFailureException
- This exception is thrown when a verification code fails to deliver successfully.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.InvalidLambdaResponseException
- This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.PreconditionNotMetException
- This exception is thrown when a precondition is not met.InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException
- This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UnsupportedUserStateException
- The request failed because the user is in an unsupported state.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public AdminDeleteUserResult adminDeleteUser(AdminDeleteUserRequest request)
Deletes a user as an administrator. Works on any user.
Requires developer credentials.
adminDeleteUser
in interface AWSCognitoIdentityProvider
adminDeleteUserRequest
- Represents the request to delete a user as an administrator.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public AdminDeleteUserAttributesResult adminDeleteUserAttributes(AdminDeleteUserAttributesRequest request)
Deletes the user attributes in a user pool as an administrator. Works on any user.
Requires developer credentials.
adminDeleteUserAttributes
in interface AWSCognitoIdentityProvider
adminDeleteUserAttributesRequest
- Represents the request to delete user attributes as an administrator.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public AdminDisableProviderForUserResult adminDisableProviderForUser(AdminDisableProviderForUserRequest request)
Disables the user from signing in with the specified external (SAML or social) identity provider. If the user to
disable is a Cognito User Pools native username + password user, they are not permitted to use their password to
sign-in. If the user to disable is a linked external IdP user, any link between that user and an existing user is
removed. The next time the external user (no longer attached to the previously linked
DestinationUser
) signs in, they must create a new user account. See AdminLinkProviderForUser.
This action is enabled only for admin access and requires developer credentials.
The ProviderName
must match the value specified when creating an IdP for the pool.
To disable a native username + password user, the ProviderName
value must be Cognito
and the ProviderAttributeName
must be Cognito_Subject
, with the
ProviderAttributeValue
being the name that is used in the user pool for the user.
The ProviderAttributeName
must always be Cognito_Subject
for social identity providers.
The ProviderAttributeValue
must always be the exact subject that was used when the user was
originally linked as a source user.
For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign-in,
the ProviderAttributeName
and ProviderAttributeValue
must be the same values that were
used for the SourceUser
when the identities were originally linked in the AdminLinkProviderForUser call. (If the linking was done with
ProviderAttributeName
set to Cognito_Subject
, the same applies here). However, if the
user has already signed in, the ProviderAttributeName
must be Cognito_Subject
and
ProviderAttributeValue
must be the subject of the SAML assertion.
adminDisableProviderForUser
in interface AWSCognitoIdentityProvider
adminDisableProviderForUserRequest
- ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.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.public AdminDisableUserResult adminDisableUser(AdminDisableUserRequest request)
Disables the specified user as an administrator. Works on any user.
Requires developer credentials.
adminDisableUser
in interface AWSCognitoIdentityProvider
adminDisableUserRequest
- Represents the request to disable any user as an administrator.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public AdminEnableUserResult adminEnableUser(AdminEnableUserRequest request)
Enables the specified user as an administrator. Works on any user.
Requires developer credentials.
adminEnableUser
in interface AWSCognitoIdentityProvider
adminEnableUserRequest
- Represents the request that enables the user as an administrator.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public AdminForgetDeviceResult adminForgetDevice(AdminForgetDeviceRequest request)
Forgets the device, as an administrator.
Requires developer credentials.
adminForgetDevice
in interface AWSCognitoIdentityProvider
adminForgetDeviceRequest
- Sends the forgot device request, as an administrator.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public AdminGetDeviceResult adminGetDevice(AdminGetDeviceRequest request)
Gets the device, as an administrator.
Requires developer credentials.
adminGetDevice
in interface AWSCognitoIdentityProvider
adminGetDeviceRequest
- Represents the request to get the device, as an administrator.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.NotAuthorizedException
- This exception is thrown when a user is not authorized.public AdminGetUserResult adminGetUser(AdminGetUserRequest request)
Gets the specified user by user name in a user pool as an administrator. Works on any user.
Requires developer credentials.
adminGetUser
in interface AWSCognitoIdentityProvider
adminGetUserRequest
- Represents the request to get the specified user as an administrator.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public AdminInitiateAuthResult adminInitiateAuth(AdminInitiateAuthRequest request)
Initiates the authentication flow, as an administrator.
Requires developer credentials.
adminInitiateAuth
in interface AWSCognitoIdentityProvider
adminInitiateAuthRequest
- Initiates the authorization request, as an administrator.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.InvalidLambdaResponseException
- This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.MFAMethodNotFoundException
- This exception is thrown when Amazon Cognito cannot find a multi-factor authentication (MFA) method.InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException
- This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.public AdminLinkProviderForUserResult adminLinkProviderForUser(AdminLinkProviderForUserRequest request)
Links an existing user account in a user pool (DestinationUser
) to an identity from an external
identity provider (SourceUser
) based on a specified attribute name and value from the external
identity provider. This allows you to create a link from the existing user account to an external federated user
identity that has not yet been used to sign in, so that the federated user identity can be used to sign in as the
existing user account.
For example, if there is an existing user with a username and password, this API links that user to a federated user identity, so that when the federated user identity is used, the user signs in as the existing user account.
Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external identity providers and provider attributes that have been trusted by the application owner.
See also AdminDisableProviderForUser.
This action is enabled only for admin access and requires developer credentials.
adminLinkProviderForUser
in interface AWSCognitoIdentityProvider
adminLinkProviderForUserRequest
- ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.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.public AdminListDevicesResult adminListDevices(AdminListDevicesRequest request)
Lists devices, as an administrator.
Requires developer credentials.
adminListDevices
in interface AWSCognitoIdentityProvider
adminListDevicesRequest
- Represents the request to list devices, as an administrator.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.NotAuthorizedException
- This exception is thrown when a user is not authorized.public AdminListGroupsForUserResult adminListGroupsForUser(AdminListGroupsForUserRequest request)
Lists the groups that the user belongs to.
Requires developer credentials.
adminListGroupsForUser
in interface AWSCognitoIdentityProvider
adminListGroupsForUserRequest
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public AdminRemoveUserFromGroupResult adminRemoveUserFromGroup(AdminRemoveUserFromGroupRequest request)
Removes the specified user from the specified group.
Requires developer credentials.
adminRemoveUserFromGroup
in interface AWSCognitoIdentityProvider
adminRemoveUserFromGroupRequest
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public AdminResetUserPasswordResult adminResetUserPassword(AdminResetUserPasswordRequest request)
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.
adminResetUserPassword
in interface AWSCognitoIdentityProvider
adminResetUserPasswordRequest
- Represents the request to reset a user's password as an administrator.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.NotAuthorizedException
- This exception is thrown when a user is not authorized.InvalidLambdaResponseException
- This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.UserNotFoundException
- This exception is thrown when a user is not found.InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidEmailRoleAccessPolicyException
- This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code:
400.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.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public AdminRespondToAuthChallengeResult adminRespondToAuthChallenge(AdminRespondToAuthChallengeRequest request)
Responds to an authentication challenge, as an administrator.
Requires developer credentials.
adminRespondToAuthChallenge
in interface AWSCognitoIdentityProvider
adminRespondToAuthChallengeRequest
- The request to respond to the authentication challenge, as an administrator.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException
- This exception is thrown when a user is not authorized.CodeMismatchException
- This exception is thrown if the provided code does not match what the server was expecting.ExpiredCodeException
- This exception is thrown if a code has expired.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.InvalidPasswordException
- This exception is thrown when the Amazon Cognito service encounters an invalid password.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.InvalidLambdaResponseException
- This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.MFAMethodNotFoundException
- This exception is thrown when Amazon Cognito cannot find a multi-factor authentication (MFA) method.InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException
- This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.AliasExistsException
- This exception is thrown when a user tries to confirm the account with an email or phone number that has
already been supplied as an alias from a different account. This exception tells user that an account
with this email or phone already exists.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.public AdminSetUserSettingsResult adminSetUserSettings(AdminSetUserSettingsRequest request)
Sets all the user settings for a specified user name. Works on any user.
Requires developer credentials.
adminSetUserSettings
in interface AWSCognitoIdentityProvider
adminSetUserSettingsRequest
- Represents the request to set user settings as an administrator.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public AdminUpdateDeviceStatusResult adminUpdateDeviceStatus(AdminUpdateDeviceStatusRequest request)
Updates the device status as an administrator.
Requires developer credentials.
adminUpdateDeviceStatus
in interface AWSCognitoIdentityProvider
adminUpdateDeviceStatusRequest
- The request to update the device status, as an administrator.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public AdminUpdateUserAttributesResult adminUpdateUserAttributes(AdminUpdateUserAttributesRequest request)
Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.
For custom attributes, you must prepend the custom:
prefix to the attribute name.
In addition to updating user attributes, this API can also be used to mark phone and email as verified.
Requires developer credentials.
adminUpdateUserAttributes
in interface AWSCognitoIdentityProvider
adminUpdateUserAttributesRequest
- Represents the request to update the user's attributes as an administrator.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.InvalidLambdaResponseException
- This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.AliasExistsException
- This exception is thrown when a user tries to confirm the account with an email or phone number that has
already been supplied as an alias from a different account. This exception tells user that an account
with this email or phone already exists.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public AdminUserGlobalSignOutResult adminUserGlobalSignOut(AdminUserGlobalSignOutRequest request)
Signs out users from all devices, as an administrator.
Requires developer credentials.
adminUserGlobalSignOut
in interface AWSCognitoIdentityProvider
adminUserGlobalSignOutRequest
- The request to sign out of all devices, as an administrator.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public ChangePasswordResult changePassword(ChangePasswordRequest request)
Changes the password for a specified user in a user pool.
changePassword
in interface AWSCognitoIdentityProvider
changePasswordRequest
- Represents the request to change a user password.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.InvalidPasswordException
- This exception is thrown when the Amazon Cognito service encounters an invalid password.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public ConfirmDeviceResult confirmDevice(ConfirmDeviceRequest request)
Confirms tracking of the device. This API call is the call that begins device tracking.
confirmDevice
in interface AWSCognitoIdentityProvider
confirmDeviceRequest
- Confirms the device request.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException
- This exception is thrown when a user is not authorized.InvalidPasswordException
- This exception is thrown when the Amazon Cognito service encounters an invalid password.InvalidLambdaResponseException
- This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.UsernameExistsException
- This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public ConfirmForgotPasswordResult confirmForgotPassword(ConfirmForgotPasswordRequest request)
Allows a user to enter a confirmation code to reset a forgotten password.
confirmForgotPassword
in interface AWSCognitoIdentityProvider
confirmForgotPasswordRequest
- The request representing the confirmation for a password reset.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.InvalidPasswordException
- This exception is thrown when the Amazon Cognito service encounters an invalid password.NotAuthorizedException
- This exception is thrown when a user is not authorized.CodeMismatchException
- This exception is thrown if the provided code does not match what the server was expecting.ExpiredCodeException
- This exception is thrown if a code has expired.TooManyFailedAttemptsException
- This exception is thrown when the user has made too many failed attempts for a given action (e.g., sign
in).InvalidLambdaResponseException
- This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public ConfirmSignUpResult confirmSignUp(ConfirmSignUpRequest request)
Confirms registration of a user and handles the existing alias from a previous user.
confirmSignUp
in interface AWSCognitoIdentityProvider
confirmSignUpRequest
- Represents the request to confirm registration of a user.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyFailedAttemptsException
- This exception is thrown when the user has made too many failed attempts for a given action (e.g., sign
in).CodeMismatchException
- This exception is thrown if the provided code does not match what the server was expecting.ExpiredCodeException
- This exception is thrown if a code has expired.InvalidLambdaResponseException
- This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.AliasExistsException
- This exception is thrown when a user tries to confirm the account with an email or phone number that has
already been supplied as an alias from a different account. This exception tells user that an account
with this email or phone already exists.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public CreateGroupResult createGroup(CreateGroupRequest request)
Creates a new group in the specified user pool.
Requires developer credentials.
createGroup
in interface AWSCognitoIdentityProvider
createGroupRequest
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.GroupExistsException
- This exception is thrown when Amazon Cognito encounters a group that already exists in the user pool.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.NotAuthorizedException
- This exception is thrown when a user is not authorized.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public CreateIdentityProviderResult createIdentityProvider(CreateIdentityProviderRequest request)
Creates an identity provider for a user pool.
createIdentityProvider
in interface AWSCognitoIdentityProvider
createIdentityProviderRequest
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.DuplicateProviderException
- This exception is thrown when the provider is already supported by the user pool.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public CreateResourceServerResult createResourceServer(CreateResourceServerRequest request)
Creates a new OAuth2.0 resource server and defines custom scopes in it.
createResourceServer
in interface AWSCognitoIdentityProvider
createResourceServerRequest
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.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.public CreateUserImportJobResult createUserImportJob(CreateUserImportJobRequest request)
Creates the user import job.
createUserImportJob
in interface AWSCognitoIdentityProvider
createUserImportJobRequest
- Represents the request to create the user import job.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.PreconditionNotMetException
- This exception is thrown when a precondition is not met.NotAuthorizedException
- This exception is thrown when a user is not authorized.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public CreateUserPoolResult createUserPool(CreateUserPoolRequest request)
Creates a new Amazon Cognito user pool and sets the password policy for the pool.
createUserPool
in interface AWSCognitoIdentityProvider
createUserPoolRequest
- Represents the request to create a user pool.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException
- This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.InvalidEmailRoleAccessPolicyException
- This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code:
400.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserPoolTaggingException
- This exception is thrown when a user pool tag cannot be set or updated.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public CreateUserPoolClientResult createUserPoolClient(CreateUserPoolClientRequest request)
Creates the user pool client.
createUserPoolClient
in interface AWSCognitoIdentityProvider
createUserPoolClientRequest
- Represents the request to create a user pool client.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.NotAuthorizedException
- This exception is thrown when a user is not authorized.ScopeDoesNotExistException
- This exception is thrown when the specified scope does not exist.InvalidOAuthFlowException
- This exception is thrown when the specified OAuth flow is invalid.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public CreateUserPoolDomainResult createUserPoolDomain(CreateUserPoolDomainRequest request)
Creates a new domain for a user pool.
createUserPoolDomain
in interface AWSCognitoIdentityProvider
createUserPoolDomainRequest
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException
- This exception is thrown when a user is not authorized.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public DeleteGroupResult deleteGroup(DeleteGroupRequest request)
Deletes a group. Currently only groups with no members can be deleted.
Requires developer credentials.
deleteGroup
in interface AWSCognitoIdentityProvider
deleteGroupRequest
- ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public DeleteIdentityProviderResult deleteIdentityProvider(DeleteIdentityProviderRequest request)
Deletes an identity provider for a user pool.
deleteIdentityProvider
in interface AWSCognitoIdentityProvider
deleteIdentityProviderRequest
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnsupportedIdentityProviderException
- This exception is thrown when the specified identifier is not supported.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public DeleteResourceServerResult deleteResourceServer(DeleteResourceServerRequest request)
Deletes a resource server.
deleteResourceServer
in interface AWSCognitoIdentityProvider
deleteResourceServerRequest
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public DeleteUserResult deleteUser(DeleteUserRequest request)
Allows a user to delete himself or herself.
deleteUser
in interface AWSCognitoIdentityProvider
deleteUserRequest
- Represents the request to delete a user.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public DeleteUserAttributesResult deleteUserAttributes(DeleteUserAttributesRequest request)
Deletes the attributes for a user.
deleteUserAttributes
in interface AWSCognitoIdentityProvider
deleteUserAttributesRequest
- Represents the request to delete user attributes.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public DeleteUserPoolResult deleteUserPool(DeleteUserPoolRequest request)
Deletes the specified Amazon Cognito user pool.
deleteUserPool
in interface AWSCognitoIdentityProvider
deleteUserPoolRequest
- Represents the request to delete a user pool.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserImportInProgressException
- This exception is thrown when you are trying to modify a user pool while a user import job is in progress
for that pool.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public DeleteUserPoolClientResult deleteUserPoolClient(DeleteUserPoolClientRequest request)
Allows the developer to delete the user pool client.
deleteUserPoolClient
in interface AWSCognitoIdentityProvider
deleteUserPoolClientRequest
- Represents the request to delete a user pool client.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public DeleteUserPoolDomainResult deleteUserPoolDomain(DeleteUserPoolDomainRequest request)
Deletes a domain for a user pool.
deleteUserPoolDomain
in interface AWSCognitoIdentityProvider
deleteUserPoolDomainRequest
- NotAuthorizedException
- This exception is thrown when a user is not authorized.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public DescribeIdentityProviderResult describeIdentityProvider(DescribeIdentityProviderRequest request)
Gets information about a specific identity provider.
describeIdentityProvider
in interface AWSCognitoIdentityProvider
describeIdentityProviderRequest
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public DescribeResourceServerResult describeResourceServer(DescribeResourceServerRequest request)
Describes a resource server.
describeResourceServer
in interface AWSCognitoIdentityProvider
describeResourceServerRequest
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public DescribeUserImportJobResult describeUserImportJob(DescribeUserImportJobRequest request)
Describes the user import job.
describeUserImportJob
in interface AWSCognitoIdentityProvider
describeUserImportJobRequest
- Represents the request to describe the user import job.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public DescribeUserPoolResult describeUserPool(DescribeUserPoolRequest request)
Returns the configuration information and metadata of the specified user pool.
describeUserPool
in interface AWSCognitoIdentityProvider
describeUserPoolRequest
- Represents the request to describe the user pool.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserPoolTaggingException
- This exception is thrown when a user pool tag cannot be set or updated.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public DescribeUserPoolClientResult describeUserPoolClient(DescribeUserPoolClientRequest request)
Client method for returning the configuration information and metadata of the specified user pool client.
describeUserPoolClient
in interface AWSCognitoIdentityProvider
describeUserPoolClientRequest
- Represents the request to describe a user pool client.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public DescribeUserPoolDomainResult describeUserPoolDomain(DescribeUserPoolDomainRequest request)
Gets information about a domain.
describeUserPoolDomain
in interface AWSCognitoIdentityProvider
describeUserPoolDomainRequest
- NotAuthorizedException
- This exception is thrown when a user is not authorized.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public ForgetDeviceResult forgetDevice(ForgetDeviceRequest request)
Forgets the specified device.
forgetDevice
in interface AWSCognitoIdentityProvider
forgetDeviceRequest
- Represents the request to forget the device.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public ForgotPasswordResult forgotPassword(ForgotPasswordRequest request)
Calling this API causes a message to be sent to the end user with a confirmation code that is required to change
the user's password. For the Username
parameter, you can use the username or user alias. If a
verified phone number exists for the user, the confirmation code is sent to the phone number. Otherwise, if a
verified email exists, the confirmation code is sent to the email. If neither a verified phone number nor a
verified email exists, InvalidParameterException
is thrown. To use the confirmation code for
resetting the password, call ConfirmForgotPassword.
forgotPassword
in interface AWSCognitoIdentityProvider
forgotPasswordRequest
- Represents the request to reset a user's password.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.NotAuthorizedException
- This exception is thrown when a user is not authorized.InvalidLambdaResponseException
- This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException
- This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.InvalidEmailRoleAccessPolicyException
- This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code:
400.CodeDeliveryFailureException
- This exception is thrown when a verification code fails to deliver successfully.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public GetCSVHeaderResult getCSVHeader(GetCSVHeaderRequest request)
Gets the header information for the .csv file to be used as input for the user import job.
getCSVHeader
in interface AWSCognitoIdentityProvider
getCSVHeaderRequest
- Represents the request to get the header information for the .csv file for the user import job.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public GetDeviceResult getDevice(GetDeviceRequest request)
Gets the device.
getDevice
in interface AWSCognitoIdentityProvider
getDeviceRequest
- Represents the request to get the device.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public GetGroupResult getGroup(GetGroupRequest request)
Gets a group.
Requires developer credentials.
getGroup
in interface AWSCognitoIdentityProvider
getGroupRequest
- ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public GetIdentityProviderByIdentifierResult getIdentityProviderByIdentifier(GetIdentityProviderByIdentifierRequest request)
Gets the specified identity provider.
getIdentityProviderByIdentifier
in interface AWSCognitoIdentityProvider
getIdentityProviderByIdentifierRequest
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public GetUICustomizationResult getUICustomization(GetUICustomizationRequest request)
Gets the UI Customization information for a particular app client's app UI, if there is something set. If nothing
is set for the particular client, but there is an existing pool level customization (app clientId
will be ALL
), then that is returned. If nothing is present, then an empty shape is returned.
getUICustomization
in interface AWSCognitoIdentityProvider
getUICustomizationRequest
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public GetUserResult getUser(GetUserRequest request)
Gets the user attributes and metadata for a user.
getUser
in interface AWSCognitoIdentityProvider
getUserRequest
- Represents the request to get information about the user.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public GetUserAttributeVerificationCodeResult getUserAttributeVerificationCode(GetUserAttributeVerificationCodeRequest request)
Gets the user attribute verification code for the specified attribute name.
getUserAttributeVerificationCode
in interface AWSCognitoIdentityProvider
getUserAttributeVerificationCodeRequest
- Represents the request to get user attribute verification.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.InvalidLambdaResponseException
- This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException
- This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.InvalidEmailRoleAccessPolicyException
- This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code:
400.CodeDeliveryFailureException
- This exception is thrown when a verification code fails to deliver successfully.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public GlobalSignOutResult globalSignOut(GlobalSignOutRequest request)
Signs out users from all devices.
globalSignOut
in interface AWSCognitoIdentityProvider
globalSignOutRequest
- Represents the request to sign out all devices.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public InitiateAuthResult initiateAuth(InitiateAuthRequest request)
Initiates the authentication flow.
initiateAuth
in interface AWSCognitoIdentityProvider
initiateAuthRequest
- Initiates the authentication request.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.InvalidLambdaResponseException
- This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public ListDevicesResult listDevices(ListDevicesRequest request)
Lists the devices.
listDevices
in interface AWSCognitoIdentityProvider
listDevicesRequest
- Represents the request to list the devices.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException
- This exception is thrown when a user is not authorized.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public ListGroupsResult listGroups(ListGroupsRequest request)
Lists the groups associated with a user pool.
Requires developer credentials.
listGroups
in interface AWSCognitoIdentityProvider
listGroupsRequest
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public ListIdentityProvidersResult listIdentityProviders(ListIdentityProvidersRequest request)
Lists information about all identity providers for a user pool.
listIdentityProviders
in interface AWSCognitoIdentityProvider
listIdentityProvidersRequest
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public ListResourceServersResult listResourceServers(ListResourceServersRequest request)
Lists the resource servers for a user pool.
listResourceServers
in interface AWSCognitoIdentityProvider
listResourceServersRequest
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public ListUserImportJobsResult listUserImportJobs(ListUserImportJobsRequest request)
Lists the user import jobs.
listUserImportJobs
in interface AWSCognitoIdentityProvider
listUserImportJobsRequest
- Represents the request to list the user import jobs.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public ListUserPoolClientsResult listUserPoolClients(ListUserPoolClientsRequest request)
Lists the clients that have been created for the specified user pool.
listUserPoolClients
in interface AWSCognitoIdentityProvider
listUserPoolClientsRequest
- Represents the request to list the user pool clients.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public ListUserPoolsResult listUserPools(ListUserPoolsRequest request)
Lists the user pools associated with an AWS account.
listUserPools
in interface AWSCognitoIdentityProvider
listUserPoolsRequest
- Represents the request to list user pools.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public ListUsersResult listUsers(ListUsersRequest request)
Lists the users in the Amazon Cognito user pool.
listUsers
in interface AWSCognitoIdentityProvider
listUsersRequest
- Represents the request to list users.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public ListUsersInGroupResult listUsersInGroup(ListUsersInGroupRequest request)
Lists the users in the specified group.
Requires developer credentials.
listUsersInGroup
in interface AWSCognitoIdentityProvider
listUsersInGroupRequest
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public ResendConfirmationCodeResult resendConfirmationCode(ResendConfirmationCodeRequest request)
Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
resendConfirmationCode
in interface AWSCognitoIdentityProvider
resendConfirmationCodeRequest
- Represents the request to resend the confirmation code.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.NotAuthorizedException
- This exception is thrown when a user is not authorized.InvalidLambdaResponseException
- This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException
- This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.InvalidEmailRoleAccessPolicyException
- This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code:
400.CodeDeliveryFailureException
- This exception is thrown when a verification code fails to deliver successfully.UserNotFoundException
- This exception is thrown when a user is not found.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public RespondToAuthChallengeResult respondToAuthChallenge(RespondToAuthChallengeRequest request)
Responds to the authentication challenge.
respondToAuthChallenge
in interface AWSCognitoIdentityProvider
respondToAuthChallengeRequest
- The request to respond to an authentication challenge.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException
- This exception is thrown when a user is not authorized.CodeMismatchException
- This exception is thrown if the provided code does not match what the server was expecting.ExpiredCodeException
- This exception is thrown if a code has expired.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.InvalidPasswordException
- This exception is thrown when the Amazon Cognito service encounters an invalid password.InvalidLambdaResponseException
- This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.MFAMethodNotFoundException
- This exception is thrown when Amazon Cognito cannot find a multi-factor authentication (MFA) method.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException
- This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.AliasExistsException
- This exception is thrown when a user tries to confirm the account with an email or phone number that has
already been supplied as an alias from a different account. This exception tells user that an account
with this email or phone already exists.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public SetUICustomizationResult setUICustomization(SetUICustomizationRequest request)
Sets the UI customization information for a user pool's built-in app UI.
You can specify app UI customization settings for a single client (with a specific clientId
) or for
all clients (by setting the clientId
to ALL
). If you specify ALL
, the
default configuration will be used for every client that has no UI customization set previously. If you specify
UI customization settings for a particular client, it will no longer fall back to the ALL
configuration.
To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app's pages, and the service will throw an error.
setUICustomization
in interface AWSCognitoIdentityProvider
setUICustomizationRequest
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public SetUserSettingsResult setUserSettings(SetUserSettingsRequest request)
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 AWSCognitoIdentityProvider
setUserSettingsRequest
- Represents the request to set user settings.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException
- This exception is thrown when a user is not authorized.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public SignUpResult signUp(SignUpRequest request)
Registers the user in the specified user pool and creates a user name, password, and user attributes.
signUp
in interface AWSCognitoIdentityProvider
signUpRequest
- Represents the request to register a user.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.NotAuthorizedException
- This exception is thrown when a user is not authorized.InvalidPasswordException
- This exception is thrown when the Amazon Cognito service encounters an invalid password.InvalidLambdaResponseException
- This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.UsernameExistsException
- This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException
- This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.InvalidEmailRoleAccessPolicyException
- This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code:
400.CodeDeliveryFailureException
- This exception is thrown when a verification code fails to deliver successfully.public StartUserImportJobResult startUserImportJob(StartUserImportJobRequest request)
Starts the user import.
startUserImportJob
in interface AWSCognitoIdentityProvider
startUserImportJobRequest
- Represents the request to start the user import job.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.PreconditionNotMetException
- This exception is thrown when a precondition is not met.NotAuthorizedException
- This exception is thrown when a user is not authorized.public StopUserImportJobResult stopUserImportJob(StopUserImportJobRequest request)
Stops the user import job.
stopUserImportJob
in interface AWSCognitoIdentityProvider
stopUserImportJobRequest
- Represents the request to stop the user import job.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.PreconditionNotMetException
- This exception is thrown when a precondition is not met.NotAuthorizedException
- This exception is thrown when a user is not authorized.public UpdateDeviceStatusResult updateDeviceStatus(UpdateDeviceStatusRequest request)
Updates the device status.
updateDeviceStatus
in interface AWSCognitoIdentityProvider
updateDeviceStatusRequest
- Represents the request to update the device status.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException
- This exception is thrown when a user is not authorized.InvalidUserPoolConfigurationException
- This exception is thrown when the user pool configuration is invalid.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public UpdateGroupResult updateGroup(UpdateGroupRequest request)
Updates the specified group with the specified attributes.
Requires developer credentials.
updateGroup
in interface AWSCognitoIdentityProvider
updateGroupRequest
- ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public UpdateIdentityProviderResult updateIdentityProvider(UpdateIdentityProviderRequest request)
Updates identity provider information for a user pool.
updateIdentityProvider
in interface AWSCognitoIdentityProvider
updateIdentityProviderRequest
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnsupportedIdentityProviderException
- This exception is thrown when the specified identifier is not supported.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public UpdateResourceServerResult updateResourceServer(UpdateResourceServerRequest request)
Updates the name and scopes of resource server. All other fields are read-only.
updateResourceServer
in interface AWSCognitoIdentityProvider
updateResourceServerRequest
- InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public UpdateUserAttributesResult updateUserAttributes(UpdateUserAttributesRequest request)
Allows a user to update a specific attribute (one at a time).
updateUserAttributes
in interface AWSCognitoIdentityProvider
updateUserAttributesRequest
- Represents the request to update user attributes.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.CodeMismatchException
- This exception is thrown if the provided code does not match what the server was expecting.ExpiredCodeException
- This exception is thrown if a code has expired.NotAuthorizedException
- This exception is thrown when a user is not authorized.UnexpectedLambdaException
- This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException
- This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.InvalidLambdaResponseException
- This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.AliasExistsException
- This exception is thrown when a user tries to confirm the account with an email or phone number that has
already been supplied as an alias from a different account. This exception tells user that an account
with this email or phone already exists.InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException
- This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.InvalidEmailRoleAccessPolicyException
- This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code:
400.CodeDeliveryFailureException
- This exception is thrown when a verification code fails to deliver successfully.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public UpdateUserPoolResult updateUserPool(UpdateUserPoolRequest request)
Updates the specified user pool with the specified attributes.
updateUserPool
in interface AWSCognitoIdentityProvider
updateUserPoolRequest
- Represents the request to update the user pool.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ConcurrentModificationException
- This exception is thrown if two or more modifications are happening concurrently.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.UserImportInProgressException
- This exception is thrown when you are trying to modify a user pool while a user import job is in progress
for that pool.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.InvalidSmsRoleAccessPolicyException
- This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException
- This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.UserPoolTaggingException
- This exception is thrown when a user pool tag cannot be set or updated.InvalidEmailRoleAccessPolicyException
- This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code:
400.public UpdateUserPoolClientResult updateUserPoolClient(UpdateUserPoolClientRequest request)
Allows the developer to update the specified user pool client and password policy.
updateUserPoolClient
in interface AWSCognitoIdentityProvider
updateUserPoolClientRequest
- Represents the request to update the user pool client.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException
- This exception is thrown when a user is not authorized.ScopeDoesNotExistException
- This exception is thrown when the specified scope does not exist.InvalidOAuthFlowException
- This exception is thrown when the specified OAuth flow is invalid.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.public VerifyUserAttributeResult verifyUserAttribute(VerifyUserAttributeRequest request)
Verifies the specified user attributes in the user pool.
verifyUserAttribute
in interface AWSCognitoIdentityProvider
verifyUserAttributeRequest
- Represents the request to verify user attributes.ResourceNotFoundException
- This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException
- This exception is thrown when the Amazon Cognito service encounters an invalid parameter.CodeMismatchException
- This exception is thrown if the provided code does not match what the server was expecting.ExpiredCodeException
- This exception is thrown if a code has expired.NotAuthorizedException
- This exception is thrown when a user is not authorized.TooManyRequestsException
- This exception is thrown when the user has made too many requests for a given operation.LimitExceededException
- This exception is thrown when a user exceeds the limit for a requested AWS resource.PasswordResetRequiredException
- This exception is thrown when a password reset is required.UserNotFoundException
- This exception is thrown when a user is not found.UserNotConfirmedException
- This exception is thrown when a user is not confirmed successfully.InternalErrorException
- This exception is thrown when Amazon Cognito encounters an internal error.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 AWSCognitoIdentityProvider
request
- The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.