@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSCognitoIdentityProvider
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSCognitoIdentityProvider instead.
Using the Amazon Cognito User Pools API, you can create a user pool to manage directories and users. You can authenticate a user to obtain tokens related to user identity and access policies.
This API reference provides information about user pools in Amazon Cognito User Pools.
For more information, see the Amazon Cognito Documentation.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
AddCustomAttributesResult |
addCustomAttributes(AddCustomAttributesRequest addCustomAttributesRequest)
Adds additional user attributes to the user pool schema.
|
AdminAddUserToGroupResult |
adminAddUserToGroup(AdminAddUserToGroupRequest adminAddUserToGroupRequest)
Adds the specified user to the specified group.
|
AdminConfirmSignUpResult |
adminConfirmSignUp(AdminConfirmSignUpRequest adminConfirmSignUpRequest)
Confirms user registration as an admin without using a confirmation code.
|
AdminCreateUserResult |
adminCreateUser(AdminCreateUserRequest adminCreateUserRequest)
Creates a new user in the specified user pool.
|
AdminDeleteUserResult |
adminDeleteUser(AdminDeleteUserRequest adminDeleteUserRequest)
Deletes a user as an administrator.
|
AdminDeleteUserAttributesResult |
adminDeleteUserAttributes(AdminDeleteUserAttributesRequest adminDeleteUserAttributesRequest)
Deletes the user attributes in a user pool as an administrator.
|
AdminDisableProviderForUserResult |
adminDisableProviderForUser(AdminDisableProviderForUserRequest adminDisableProviderForUserRequest)
Disables the user from signing in with the specified external (SAML or social) identity provider.
|
AdminDisableUserResult |
adminDisableUser(AdminDisableUserRequest adminDisableUserRequest)
Disables the specified user.
|
AdminEnableUserResult |
adminEnableUser(AdminEnableUserRequest adminEnableUserRequest)
Enables the specified user as an administrator.
|
AdminForgetDeviceResult |
adminForgetDevice(AdminForgetDeviceRequest adminForgetDeviceRequest)
Forgets the device, as an administrator.
|
AdminGetDeviceResult |
adminGetDevice(AdminGetDeviceRequest adminGetDeviceRequest)
Gets the device, as an administrator.
|
AdminGetUserResult |
adminGetUser(AdminGetUserRequest adminGetUserRequest)
Gets the specified user by user name in a user pool as an administrator.
|
AdminInitiateAuthResult |
adminInitiateAuth(AdminInitiateAuthRequest adminInitiateAuthRequest)
Initiates the authentication flow, as an administrator.
|
AdminLinkProviderForUserResult |
adminLinkProviderForUser(AdminLinkProviderForUserRequest adminLinkProviderForUserRequest)
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 adminListDevicesRequest)
Lists devices, as an administrator.
|
AdminListGroupsForUserResult |
adminListGroupsForUser(AdminListGroupsForUserRequest adminListGroupsForUserRequest)
Lists the groups that the user belongs to.
|
AdminListUserAuthEventsResult |
adminListUserAuthEvents(AdminListUserAuthEventsRequest adminListUserAuthEventsRequest)
Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security.
|
AdminRemoveUserFromGroupResult |
adminRemoveUserFromGroup(AdminRemoveUserFromGroupRequest adminRemoveUserFromGroupRequest)
Removes the specified user from the specified group.
|
AdminResetUserPasswordResult |
adminResetUserPassword(AdminResetUserPasswordRequest adminResetUserPasswordRequest)
Resets the specified user's password in a user pool as an administrator.
|
AdminRespondToAuthChallengeResult |
adminRespondToAuthChallenge(AdminRespondToAuthChallengeRequest adminRespondToAuthChallengeRequest)
Responds to an authentication challenge, as an administrator.
|
AdminSetUserMFAPreferenceResult |
adminSetUserMFAPreference(AdminSetUserMFAPreferenceRequest adminSetUserMFAPreferenceRequest)
Sets the user's multi-factor authentication (MFA) preference, including which MFA options are enabled and if any
are preferred.
|
AdminSetUserPasswordResult |
adminSetUserPassword(AdminSetUserPasswordRequest adminSetUserPasswordRequest)
Sets the specified user's password in a user pool as an administrator.
|
AdminSetUserSettingsResult |
adminSetUserSettings(AdminSetUserSettingsRequest adminSetUserSettingsRequest)
This action is no longer supported. You can use it to configure only SMS MFA.
|
AdminUpdateAuthEventFeedbackResult |
adminUpdateAuthEventFeedback(AdminUpdateAuthEventFeedbackRequest adminUpdateAuthEventFeedbackRequest)
Provides feedback for an authentication event as to whether it was from a valid user.
|
AdminUpdateDeviceStatusResult |
adminUpdateDeviceStatus(AdminUpdateDeviceStatusRequest adminUpdateDeviceStatusRequest)
Updates the device status as an administrator.
|
AdminUpdateUserAttributesResult |
adminUpdateUserAttributes(AdminUpdateUserAttributesRequest adminUpdateUserAttributesRequest)
Updates the specified user's attributes, including developer attributes, as an administrator.
|
AdminUserGlobalSignOutResult |
adminUserGlobalSignOut(AdminUserGlobalSignOutRequest adminUserGlobalSignOutRequest)
Signs out users from all devices, as an administrator.
|
AssociateSoftwareTokenResult |
associateSoftwareToken(AssociateSoftwareTokenRequest associateSoftwareTokenRequest)
Returns a unique generated shared secret key code for the user account.
|
ChangePasswordResult |
changePassword(ChangePasswordRequest changePasswordRequest)
Changes the password for a specified user in a user pool.
|
ConfirmDeviceResult |
confirmDevice(ConfirmDeviceRequest confirmDeviceRequest)
Confirms tracking of the device.
|
ConfirmForgotPasswordResult |
confirmForgotPassword(ConfirmForgotPasswordRequest confirmForgotPasswordRequest)
Allows a user to enter a confirmation code to reset a forgotten password.
|
ConfirmSignUpResult |
confirmSignUp(ConfirmSignUpRequest confirmSignUpRequest)
Confirms registration of a user and handles the existing alias from a previous user.
|
CreateGroupResult |
createGroup(CreateGroupRequest createGroupRequest)
Creates a new group in the specified user pool.
|
CreateIdentityProviderResult |
createIdentityProvider(CreateIdentityProviderRequest createIdentityProviderRequest)
Creates an identity provider for a user pool.
|
CreateResourceServerResult |
createResourceServer(CreateResourceServerRequest createResourceServerRequest)
Creates a new OAuth2.0 resource server and defines custom scopes in it.
|
CreateUserImportJobResult |
createUserImportJob(CreateUserImportJobRequest createUserImportJobRequest)
Creates the user import job.
|
CreateUserPoolResult |
createUserPool(CreateUserPoolRequest createUserPoolRequest)
Creates a new Amazon Cognito user pool and sets the password policy for the pool.
|
CreateUserPoolClientResult |
createUserPoolClient(CreateUserPoolClientRequest createUserPoolClientRequest)
Creates the user pool client.
|
CreateUserPoolDomainResult |
createUserPoolDomain(CreateUserPoolDomainRequest createUserPoolDomainRequest)
Creates a new domain for a user pool.
|
DeleteGroupResult |
deleteGroup(DeleteGroupRequest deleteGroupRequest)
Deletes a group.
|
DeleteIdentityProviderResult |
deleteIdentityProvider(DeleteIdentityProviderRequest deleteIdentityProviderRequest)
Deletes an identity provider for a user pool.
|
DeleteResourceServerResult |
deleteResourceServer(DeleteResourceServerRequest deleteResourceServerRequest)
Deletes a resource server.
|
DeleteUserResult |
deleteUser(DeleteUserRequest deleteUserRequest)
Allows a user to delete himself or herself.
|
DeleteUserAttributesResult |
deleteUserAttributes(DeleteUserAttributesRequest deleteUserAttributesRequest)
Deletes the attributes for a user.
|
DeleteUserPoolResult |
deleteUserPool(DeleteUserPoolRequest deleteUserPoolRequest)
Deletes the specified Amazon Cognito user pool.
|
DeleteUserPoolClientResult |
deleteUserPoolClient(DeleteUserPoolClientRequest deleteUserPoolClientRequest)
Allows the developer to delete the user pool client.
|
DeleteUserPoolDomainResult |
deleteUserPoolDomain(DeleteUserPoolDomainRequest deleteUserPoolDomainRequest)
Deletes a domain for a user pool.
|
DescribeIdentityProviderResult |
describeIdentityProvider(DescribeIdentityProviderRequest describeIdentityProviderRequest)
Gets information about a specific identity provider.
|
DescribeResourceServerResult |
describeResourceServer(DescribeResourceServerRequest describeResourceServerRequest)
Describes a resource server.
|
DescribeRiskConfigurationResult |
describeRiskConfiguration(DescribeRiskConfigurationRequest describeRiskConfigurationRequest)
Describes the risk configuration.
|
DescribeUserImportJobResult |
describeUserImportJob(DescribeUserImportJobRequest describeUserImportJobRequest)
Describes the user import job.
|
DescribeUserPoolResult |
describeUserPool(DescribeUserPoolRequest describeUserPoolRequest)
Returns the configuration information and metadata of the specified user pool.
|
DescribeUserPoolClientResult |
describeUserPoolClient(DescribeUserPoolClientRequest describeUserPoolClientRequest)
Client method for returning the configuration information and metadata of the specified user pool app client.
|
DescribeUserPoolDomainResult |
describeUserPoolDomain(DescribeUserPoolDomainRequest describeUserPoolDomainRequest)
Gets information about a domain.
|
ForgetDeviceResult |
forgetDevice(ForgetDeviceRequest forgetDeviceRequest)
Forgets the specified device.
|
ForgotPasswordResult |
forgotPassword(ForgotPasswordRequest forgotPasswordRequest)
Calling this API causes a message to be sent to the end user with a confirmation code that is required to change
the user's password.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetCSVHeaderResult |
getCSVHeader(GetCSVHeaderRequest getCSVHeaderRequest)
Gets the header information for the .csv file to be used as input for the user import job.
|
GetDeviceResult |
getDevice(GetDeviceRequest getDeviceRequest)
Gets the device.
|
GetGroupResult |
getGroup(GetGroupRequest getGroupRequest)
Gets a group.
|
GetIdentityProviderByIdentifierResult |
getIdentityProviderByIdentifier(GetIdentityProviderByIdentifierRequest getIdentityProviderByIdentifierRequest)
Gets the specified identity provider.
|
GetSigningCertificateResult |
getSigningCertificate(GetSigningCertificateRequest getSigningCertificateRequest)
This method takes a user pool ID, and returns the signing certificate.
|
GetUICustomizationResult |
getUICustomization(GetUICustomizationRequest getUICustomizationRequest)
Gets the UI Customization information for a particular app client's app UI, if there is something set.
|
GetUserResult |
getUser(GetUserRequest getUserRequest)
Gets the user attributes and metadata for a user.
|
GetUserAttributeVerificationCodeResult |
getUserAttributeVerificationCode(GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest)
Gets the user attribute verification code for the specified attribute name.
|
GetUserPoolMfaConfigResult |
getUserPoolMfaConfig(GetUserPoolMfaConfigRequest getUserPoolMfaConfigRequest)
Gets the user pool multi-factor authentication (MFA) configuration.
|
GlobalSignOutResult |
globalSignOut(GlobalSignOutRequest globalSignOutRequest)
Signs out users from all devices.
|
InitiateAuthResult |
initiateAuth(InitiateAuthRequest initiateAuthRequest)
Initiates the authentication flow.
|
ListDevicesResult |
listDevices(ListDevicesRequest listDevicesRequest)
Lists the devices.
|
ListGroupsResult |
listGroups(ListGroupsRequest listGroupsRequest)
Lists the groups associated with a user pool.
|
ListIdentityProvidersResult |
listIdentityProviders(ListIdentityProvidersRequest listIdentityProvidersRequest)
Lists information about all identity providers for a user pool.
|
ListResourceServersResult |
listResourceServers(ListResourceServersRequest listResourceServersRequest)
Lists the resource servers for a user pool.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags that are assigned to an Amazon Cognito user pool.
|
ListUserImportJobsResult |
listUserImportJobs(ListUserImportJobsRequest listUserImportJobsRequest)
Lists the user import jobs.
|
ListUserPoolClientsResult |
listUserPoolClients(ListUserPoolClientsRequest listUserPoolClientsRequest)
Lists the clients that have been created for the specified user pool.
|
ListUserPoolsResult |
listUserPools(ListUserPoolsRequest listUserPoolsRequest)
Lists the user pools associated with an AWS account.
|
ListUsersResult |
listUsers(ListUsersRequest listUsersRequest)
Lists the users in the Amazon Cognito user pool.
|
ListUsersInGroupResult |
listUsersInGroup(ListUsersInGroupRequest listUsersInGroupRequest)
Lists the users in the specified group.
|
ResendConfirmationCodeResult |
resendConfirmationCode(ResendConfirmationCodeRequest resendConfirmationCodeRequest)
Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
|
RespondToAuthChallengeResult |
respondToAuthChallenge(RespondToAuthChallengeRequest respondToAuthChallengeRequest)
Responds to the authentication challenge.
|
void |
setEndpoint(String endpoint)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
void |
setRegion(Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
SetRiskConfigurationResult |
setRiskConfiguration(SetRiskConfigurationRequest setRiskConfigurationRequest)
Configures actions on detected risks.
|
SetUICustomizationResult |
setUICustomization(SetUICustomizationRequest setUICustomizationRequest)
Sets the UI customization information for a user pool's built-in app UI.
|
SetUserMFAPreferenceResult |
setUserMFAPreference(SetUserMFAPreferenceRequest setUserMFAPreferenceRequest)
Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are enabled and
if any are preferred.
|
SetUserPoolMfaConfigResult |
setUserPoolMfaConfig(SetUserPoolMfaConfigRequest setUserPoolMfaConfigRequest)
Set the user pool multi-factor authentication (MFA) configuration.
|
SetUserSettingsResult |
setUserSettings(SetUserSettingsRequest setUserSettingsRequest)
This action is no longer supported. You can use it to configure only SMS MFA.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
SignUpResult |
signUp(SignUpRequest signUpRequest)
Registers the user in the specified user pool and creates a user name, password, and user attributes.
|
StartUserImportJobResult |
startUserImportJob(StartUserImportJobRequest startUserImportJobRequest)
Starts the user import.
|
StopUserImportJobResult |
stopUserImportJob(StopUserImportJobRequest stopUserImportJobRequest)
Stops the user import job.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Assigns a set of tags to an Amazon Cognito user pool.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes the specified tags from an Amazon Cognito user pool.
|
UpdateAuthEventFeedbackResult |
updateAuthEventFeedback(UpdateAuthEventFeedbackRequest updateAuthEventFeedbackRequest)
Provides the feedback for an authentication event whether it was from a valid user or not.
|
UpdateDeviceStatusResult |
updateDeviceStatus(UpdateDeviceStatusRequest updateDeviceStatusRequest)
Updates the device status.
|
UpdateGroupResult |
updateGroup(UpdateGroupRequest updateGroupRequest)
Updates the specified group with the specified attributes.
|
UpdateIdentityProviderResult |
updateIdentityProvider(UpdateIdentityProviderRequest updateIdentityProviderRequest)
Updates identity provider information for a user pool.
|
UpdateResourceServerResult |
updateResourceServer(UpdateResourceServerRequest updateResourceServerRequest)
Updates the name and scopes of resource server.
|
UpdateUserAttributesResult |
updateUserAttributes(UpdateUserAttributesRequest updateUserAttributesRequest)
Allows a user to update a specific attribute (one at a time).
|
UpdateUserPoolResult |
updateUserPool(UpdateUserPoolRequest updateUserPoolRequest)
Updates the specified user pool with the specified attributes.
|
UpdateUserPoolClientResult |
updateUserPoolClient(UpdateUserPoolClientRequest updateUserPoolClientRequest)
Updates the specified user pool app client with the specified attributes.
|
UpdateUserPoolDomainResult |
updateUserPoolDomain(UpdateUserPoolDomainRequest updateUserPoolDomainRequest)
Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.
|
VerifySoftwareTokenResult |
verifySoftwareToken(VerifySoftwareTokenRequest verifySoftwareTokenRequest)
Use this API to register a user's entered TOTP code and mark the user's software token MFA status as "verified"
if successful.
|
VerifyUserAttributeResult |
verifyUserAttribute(VerifyUserAttributeRequest verifyUserAttributeRequest)
Verifies the specified user attributes in the user pool.
|
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
Callers can pass in just the endpoint (ex: "cognito-idp.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "https://cognito-idp.us-east-1.amazonaws.com"). If the protocol is not specified here, the default
protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint - The endpoint (ex: "cognito-idp.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"https://cognito-idp.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will
communicate with.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)setEndpoint(String), sets the regional endpoint for this
client's service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)AddCustomAttributesResult addCustomAttributes(AddCustomAttributesRequest addCustomAttributesRequest)
Adds additional user attributes to the user pool schema.
addCustomAttributesRequest - Represents the request to add custom attributes.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException - This exception is thrown when a user is not authorized.UserImportInProgressException - This exception is thrown when you are trying to modify a user pool while a user import job is in progress
for that pool.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.AdminAddUserToGroupResult adminAddUserToGroup(AdminAddUserToGroupRequest adminAddUserToGroupRequest)
Adds the specified user to the specified group.
Calling this action requires developer credentials.
adminAddUserToGroupRequest - InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException - This exception is thrown when a user is not authorized.UserNotFoundException - This exception is thrown when a user is not found.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.AdminConfirmSignUpResult adminConfirmSignUp(AdminConfirmSignUpRequest adminConfirmSignUpRequest)
Confirms user registration as an admin without using a confirmation code. Works on any user.
Calling this action requires developer credentials.
adminConfirmSignUpRequest - Represents the request to confirm user registration.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnexpectedLambdaException - This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.NotAuthorizedException - This exception is thrown when a user is not authorized.TooManyFailedAttemptsException - This exception is thrown when the user has made too many failed attempts for a given action (e.g., sign
in).InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.LimitExceededException - This exception is thrown when a user exceeds the limit for a requested AWS resource.UserNotFoundException - This exception is thrown when a user is not found.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.AdminCreateUserResult adminCreateUser(AdminCreateUserRequest adminCreateUserRequest)
Creates a new user in the specified user pool.
If MessageAction is not set, the default is to send a welcome message via email or phone (SMS).
This message is based on a template that you configured in your call to or . This template includes your custom sign-up instructions and placeholders for user name and temporary password.
Alternatively, you can call AdminCreateUser with “SUPPRESS” for the MessageAction parameter, and
Amazon Cognito will not send any email.
In either case, the user will be in the FORCE_CHANGE_PASSWORD state until they sign in and change
their password.
AdminCreateUser requires developer credentials.
adminCreateUserRequest - Represents the request to create a user in the specified user pool.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UserNotFoundException - This exception is thrown when a user is not found.UsernameExistsException - This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.InvalidPasswordException - This exception is thrown when the Amazon Cognito service encounters an invalid password.CodeDeliveryFailureException - This exception is thrown when a verification code fails to deliver successfully.UnexpectedLambdaException - This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.PreconditionNotMetException - This exception is thrown when a precondition is not met.InvalidSmsRoleAccessPolicyException - This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException - This exception is thrown when a user is not authorized.UnsupportedUserStateException - The request failed because the user is in an unsupported state.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.AdminDeleteUserResult adminDeleteUser(AdminDeleteUserRequest adminDeleteUserRequest)
Deletes a user as an administrator. Works on any user.
Calling this action requires developer credentials.
adminDeleteUserRequest - Represents the request to delete a user as an administrator.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException - This exception is thrown when a user is not authorized.UserNotFoundException - This exception is thrown when a user is not found.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.AdminDeleteUserAttributesResult adminDeleteUserAttributes(AdminDeleteUserAttributesRequest adminDeleteUserAttributesRequest)
Deletes the user attributes in a user pool as an administrator. Works on any user.
Calling this action requires developer credentials.
adminDeleteUserAttributesRequest - Represents the request to delete user attributes as an administrator.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException - This exception is thrown when a user is not authorized.UserNotFoundException - This exception is thrown when a user is not found.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.AdminDisableProviderForUserResult adminDisableProviderForUser(AdminDisableProviderForUserRequest adminDisableProviderForUserRequest)
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 .
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 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.
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.AdminDisableUserResult adminDisableUser(AdminDisableUserRequest adminDisableUserRequest)
Disables the specified user.
Calling this action requires developer credentials.
adminDisableUserRequest - Represents the request to disable any user as an administrator.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException - This exception is thrown when a user is not authorized.UserNotFoundException - This exception is thrown when a user is not found.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.AdminEnableUserResult adminEnableUser(AdminEnableUserRequest adminEnableUserRequest)
Enables the specified user as an administrator. Works on any user.
Calling this action requires developer credentials.
adminEnableUserRequest - Represents the request that enables the user as an administrator.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException - This exception is thrown when a user is not authorized.UserNotFoundException - This exception is thrown when a user is not found.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.AdminForgetDeviceResult adminForgetDevice(AdminForgetDeviceRequest adminForgetDeviceRequest)
Forgets the device, as an administrator.
Calling this action requires developer credentials.
adminForgetDeviceRequest - Sends the forgot device request, as an administrator.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.InvalidUserPoolConfigurationException - This exception is thrown when the user pool configuration is invalid.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException - This exception is thrown when a user is not authorized.UserNotFoundException - This exception is thrown when a user is not found.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.AdminGetDeviceResult adminGetDevice(AdminGetDeviceRequest adminGetDeviceRequest)
Gets the device, as an administrator.
Calling this action requires developer credentials.
adminGetDeviceRequest - Represents the request to get the device, as an administrator.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.InvalidUserPoolConfigurationException - This exception is thrown when the user pool configuration is invalid.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.NotAuthorizedException - This exception is thrown when a user is not authorized.AdminGetUserResult adminGetUser(AdminGetUserRequest adminGetUserRequest)
Gets the specified user by user name in a user pool as an administrator. Works on any user.
Calling this action requires developer credentials.
adminGetUserRequest - Represents the request to get the specified user as an administrator.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException - This exception is thrown when a user is not authorized.UserNotFoundException - This exception is thrown when a user is not found.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.AdminInitiateAuthResult adminInitiateAuth(AdminInitiateAuthRequest adminInitiateAuthRequest)
Initiates the authentication flow, as an administrator.
Calling this action requires developer credentials.
adminInitiateAuthRequest - Initiates the authorization request, as an administrator.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException - This exception is thrown when a user is not authorized.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.UnexpectedLambdaException - This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.InvalidUserPoolConfigurationException - This exception is thrown when the user pool configuration is invalid.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.MFAMethodNotFoundException - This exception is thrown when Amazon Cognito cannot find a multi-factor authentication (MFA) method.InvalidSmsRoleAccessPolicyException - This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user is not found.UserNotConfirmedException - This exception is thrown when a user is not confirmed successfully.AdminLinkProviderForUserResult adminLinkProviderForUser(AdminLinkProviderForUserRequest adminLinkProviderForUserRequest)
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 .
This action is enabled only for admin access and requires developer credentials.
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.AdminListDevicesResult adminListDevices(AdminListDevicesRequest adminListDevicesRequest)
Lists devices, as an administrator.
Calling this action requires developer credentials.
adminListDevicesRequest - Represents the request to list devices, as an administrator.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidUserPoolConfigurationException - This exception is thrown when the user pool configuration is invalid.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.NotAuthorizedException - This exception is thrown when a user is not authorized.AdminListGroupsForUserResult adminListGroupsForUser(AdminListGroupsForUserRequest adminListGroupsForUserRequest)
Lists the groups that the user belongs to.
Calling this action requires developer credentials.
adminListGroupsForUserRequest - InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException - This exception is thrown when a user is not authorized.UserNotFoundException - This exception is thrown when a user is not found.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.AdminListUserAuthEventsResult adminListUserAuthEvents(AdminListUserAuthEventsRequest adminListUserAuthEventsRequest)
Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security.
adminListUserAuthEventsRequest - 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.UserPoolAddOnNotEnabledException - This exception is thrown when user pool add-ons are not enabled.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.AdminRemoveUserFromGroupResult adminRemoveUserFromGroup(AdminRemoveUserFromGroupRequest adminRemoveUserFromGroupRequest)
Removes the specified user from the specified group.
Calling this action requires developer credentials.
adminRemoveUserFromGroupRequest - InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException - This exception is thrown when a user is not authorized.UserNotFoundException - This exception is thrown when a user is not found.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.AdminResetUserPasswordResult adminResetUserPassword(AdminResetUserPasswordRequest adminResetUserPasswordRequest)
Resets the specified user's password in a user pool as an administrator. Works on any user.
When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password.
Calling this action requires developer credentials.
adminResetUserPasswordRequest - Represents the request to reset a user's password as an administrator.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnexpectedLambdaException - This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.NotAuthorizedException - This exception is thrown when a user is not authorized.InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.LimitExceededException - This exception is thrown when a user exceeds the limit for a requested AWS resource.UserNotFoundException - This exception is thrown when a user is not found.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.AdminRespondToAuthChallengeResult adminRespondToAuthChallenge(AdminRespondToAuthChallengeRequest adminRespondToAuthChallengeRequest)
Responds to an authentication challenge, as an administrator.
Calling this action requires developer credentials.
adminRespondToAuthChallengeRequest - The request to respond to the authentication challenge, as an administrator.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException - This exception is thrown when a user is not authorized.CodeMismatchException - This exception is thrown if the provided code does not match what the server was expecting.ExpiredCodeException - This exception is thrown if a code has expired.UnexpectedLambdaException - This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.InvalidPasswordException - This exception is thrown when the Amazon Cognito service encounters an invalid password.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.InvalidUserPoolConfigurationException - This exception is thrown when the user pool configuration is invalid.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.MFAMethodNotFoundException - This exception is thrown when Amazon Cognito cannot find a multi-factor authentication (MFA) method.InvalidSmsRoleAccessPolicyException - This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.AliasExistsException - This exception is thrown when a user tries to confirm the account with an email or phone number that has
already been supplied as an alias from a different account. This exception tells user that an account
with this email or phone already exists.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user is not found.UserNotConfirmedException - This exception is thrown when a user is not confirmed successfully.SoftwareTokenMFANotFoundException - This exception is thrown when the software token TOTP multi-factor authentication (MFA) is not enabled
for the user pool.AdminSetUserMFAPreferenceResult adminSetUserMFAPreference(AdminSetUserMFAPreferenceRequest adminSetUserMFAPreferenceRequest)
Sets the user's multi-factor authentication (MFA) preference, including which MFA options are enabled and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are enabled. If multiple options are enabled and no preference is set, a challenge to choose an MFA option will be returned during sign in.
adminSetUserMFAPreferenceRequest - 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.AdminSetUserPasswordResult adminSetUserPassword(AdminSetUserPasswordRequest adminSetUserPasswordRequest)
Sets the specified user's password in a user pool as an administrator. Works on any user.
The password can be temporary or permanent. If it is temporary, the user status will be placed into the
FORCE_CHANGE_PASSWORD state. When the user next tries to sign in, the InitiateAuth/AdminInitiateAuth
response will contain the NEW_PASSWORD_REQUIRED challenge. If the user does not sign in before it
expires, the user will not be able to sign in and their password will need to be reset by an administrator.
Once the user has set a new password, or the password is permanent, the user status will be set to
Confirmed.
adminSetUserPasswordRequest - 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.UserNotFoundException - This exception is thrown when a user is not found.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.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.AdminSetUserSettingsResult adminSetUserSettings(AdminSetUserSettingsRequest adminSetUserSettingsRequest)
This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either type of MFA, use the AdminSetUserMFAPreference action instead.
adminSetUserSettingsRequest - You can use this parameter to set an MFA configuration that uses the SMS delivery medium.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.AdminUpdateAuthEventFeedbackResult adminUpdateAuthEventFeedback(AdminUpdateAuthEventFeedbackRequest adminUpdateAuthEventFeedbackRequest)
Provides feedback for an authentication event as to whether it was from a valid user. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.
adminUpdateAuthEventFeedbackRequest - 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.UserPoolAddOnNotEnabledException - This exception is thrown when user pool add-ons are not enabled.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.AdminUpdateDeviceStatusResult adminUpdateDeviceStatus(AdminUpdateDeviceStatusRequest adminUpdateDeviceStatusRequest)
Updates the device status as an administrator.
Calling this action requires developer credentials.
adminUpdateDeviceStatusRequest - The request to update the device status, as an administrator.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidUserPoolConfigurationException - This exception is thrown when the user pool configuration is invalid.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException - This exception is thrown when a user is not authorized.UserNotFoundException - This exception is thrown when a user is not found.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.AdminUpdateUserAttributesResult adminUpdateUserAttributes(AdminUpdateUserAttributesRequest adminUpdateUserAttributesRequest)
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.
Calling this action requires developer credentials.
adminUpdateUserAttributesRequest - Represents the request to update the user's attributes as an administrator.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnexpectedLambdaException - This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.AliasExistsException - This exception is thrown when a user tries to confirm the account with an email or phone number that has
already been supplied as an alias from a different account. This exception tells user that an account
with this email or phone already exists.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException - This exception is thrown when a user is not authorized.UserNotFoundException - This exception is thrown when a user is not found.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.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.AdminUserGlobalSignOutResult adminUserGlobalSignOut(AdminUserGlobalSignOutRequest adminUserGlobalSignOutRequest)
Signs out users from all devices, as an administrator. It also invalidates all refresh tokens issued to a user. The user's current access and Id tokens remain valid until their expiry. Access and Id tokens expire one hour after they are issued.
Calling this action requires developer credentials.
adminUserGlobalSignOutRequest - The request to sign out of all devices, as an administrator.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException - This exception is thrown when a user is not authorized.UserNotFoundException - This exception is thrown when a user is not found.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.AssociateSoftwareTokenResult associateSoftwareToken(AssociateSoftwareTokenRequest associateSoftwareTokenRequest)
Returns a unique generated shared secret key code for the user account. The request takes an access token or a session string, but not both.
associateSoftwareTokenRequest - 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.SoftwareTokenMFANotFoundException - This exception is thrown when the software token TOTP multi-factor authentication (MFA) is not enabled
for the user pool.ChangePasswordResult changePassword(ChangePasswordRequest changePasswordRequest)
Changes the password for a specified user in a user pool.
changePasswordRequest - Represents the request to change a user password.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.InvalidPasswordException - This exception is thrown when the Amazon Cognito service encounters an invalid password.NotAuthorizedException - This exception is thrown when a user is not authorized.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.LimitExceededException - This exception is thrown when a user exceeds the limit for a requested AWS resource.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user is not found.UserNotConfirmedException - This exception is thrown when a user is not confirmed successfully.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.ConfirmDeviceResult confirmDevice(ConfirmDeviceRequest confirmDeviceRequest)
Confirms tracking of the device. This API call is the call that begins device tracking.
confirmDeviceRequest - Confirms the device request.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException - This exception is thrown when a user is not authorized.InvalidPasswordException - This exception is thrown when the Amazon Cognito service encounters an invalid password.InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.UsernameExistsException - This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.InvalidUserPoolConfigurationException - This exception is thrown when the user pool configuration is invalid.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user is not found.UserNotConfirmedException - This exception is thrown when a user is not confirmed successfully.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.ConfirmForgotPasswordResult confirmForgotPassword(ConfirmForgotPasswordRequest confirmForgotPasswordRequest)
Allows a user to enter a confirmation code to reset a forgotten password.
confirmForgotPasswordRequest - The request representing the confirmation for a password reset.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.UnexpectedLambdaException - This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.InvalidPasswordException - This exception is thrown when the Amazon Cognito service encounters an invalid password.NotAuthorizedException - This exception is thrown when a user is not authorized.CodeMismatchException - This exception is thrown if the provided code does not match what the server was expecting.ExpiredCodeException - This exception is thrown if a code has expired.TooManyFailedAttemptsException - This exception is thrown when the user has made too many failed attempts for a given action (e.g., sign
in).InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.LimitExceededException - This exception is thrown when a user exceeds the limit for a requested AWS resource.UserNotFoundException - This exception is thrown when a user is not found.UserNotConfirmedException - This exception is thrown when a user is not confirmed successfully.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.ConfirmSignUpResult confirmSignUp(ConfirmSignUpRequest confirmSignUpRequest)
Confirms registration of a user and handles the existing alias from a previous user.
confirmSignUpRequest - Represents the request to confirm registration of a user.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnexpectedLambdaException - This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.NotAuthorizedException - This exception is thrown when a user is not authorized.TooManyFailedAttemptsException - This exception is thrown when the user has made too many failed attempts for a given action (e.g., sign
in).CodeMismatchException - This exception is thrown if the provided code does not match what the server was expecting.ExpiredCodeException - This exception is thrown if a code has expired.InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.AliasExistsException - This exception is thrown when a user tries to confirm the account with an email or phone number that has
already been supplied as an alias from a different account. This exception tells user that an account
with this email or phone already exists.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.LimitExceededException - This exception is thrown when a user exceeds the limit for a requested AWS resource.UserNotFoundException - This exception is thrown when a user is not found.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.CreateGroupResult createGroup(CreateGroupRequest createGroupRequest)
Creates a new group in the specified user pool.
Calling this action requires developer credentials.
createGroupRequest - InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.GroupExistsException - This exception is thrown when Amazon Cognito encounters a group that already exists in the user pool.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.LimitExceededException - This exception is thrown when a user exceeds the limit for a requested AWS resource.NotAuthorizedException - This exception is thrown when a user is not authorized.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.CreateIdentityProviderResult createIdentityProvider(CreateIdentityProviderRequest createIdentityProviderRequest)
Creates an identity provider for a user pool.
createIdentityProviderRequest - InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.DuplicateProviderException - This exception is thrown when the provider is already supported by the user pool.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException - This exception is thrown when a user is not authorized.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.LimitExceededException - This exception is thrown when a user exceeds the limit for a requested AWS resource.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.CreateResourceServerResult createResourceServer(CreateResourceServerRequest createResourceServerRequest)
Creates a new OAuth2.0 resource server and defines custom scopes in it.
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.CreateUserImportJobResult createUserImportJob(CreateUserImportJobRequest createUserImportJobRequest)
Creates the user import job.
createUserImportJobRequest - Represents the request to create the user import job.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.PreconditionNotMetException - This exception is thrown when a precondition is not met.NotAuthorizedException - This exception is thrown when a user is not authorized.LimitExceededException - This exception is thrown when a user exceeds the limit for a requested AWS resource.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.CreateUserPoolResult createUserPool(CreateUserPoolRequest createUserPoolRequest)
Creates a new Amazon Cognito user pool and sets the password policy for the pool.
createUserPoolRequest - Represents the request to create a user pool.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.LimitExceededException - This exception is thrown when a user exceeds the limit for a requested AWS resource.InvalidSmsRoleAccessPolicyException - This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.InvalidEmailRoleAccessPolicyException - This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code:
400.NotAuthorizedException - This exception is thrown when a user is not authorized.UserPoolTaggingException - This exception is thrown when a user pool tag cannot be set or updated.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.CreateUserPoolClientResult createUserPoolClient(CreateUserPoolClientRequest createUserPoolClientRequest)
Creates the user pool client.
createUserPoolClientRequest - Represents the request to create a user pool client.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.LimitExceededException - This exception is thrown when a user exceeds the limit for a requested AWS resource.NotAuthorizedException - This exception is thrown when a user is not authorized.ScopeDoesNotExistException - This exception is thrown when the specified scope does not exist.InvalidOAuthFlowException - This exception is thrown when the specified OAuth flow is invalid.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.CreateUserPoolDomainResult createUserPoolDomain(CreateUserPoolDomainRequest createUserPoolDomainRequest)
Creates a new domain for a user pool.
createUserPoolDomainRequest - InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException - This exception is thrown when a user is not authorized.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.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.DeleteGroupResult deleteGroup(DeleteGroupRequest deleteGroupRequest)
Deletes a group. Currently only groups with no members can be deleted.
Calling this action requires developer credentials.
deleteGroupRequest - ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException - This exception is thrown when a user is not authorized.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.DeleteIdentityProviderResult deleteIdentityProvider(DeleteIdentityProviderRequest deleteIdentityProviderRequest)
Deletes an identity provider for a user pool.
deleteIdentityProviderRequest - InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnsupportedIdentityProviderException - This exception is thrown when the specified identifier is not supported.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException - This exception is thrown when a user is not authorized.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.DeleteResourceServerResult deleteResourceServer(DeleteResourceServerRequest deleteResourceServerRequest)
Deletes a resource server.
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.DeleteUserResult deleteUser(DeleteUserRequest deleteUserRequest)
Allows a user to delete himself or herself.
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.DeleteUserAttributesResult deleteUserAttributes(DeleteUserAttributesRequest deleteUserAttributesRequest)
Deletes the attributes for a user.
deleteUserAttributesRequest - Represents the request to delete user attributes.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException - This exception is thrown when a user is not authorized.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user is not found.UserNotConfirmedException - This exception is thrown when a user is not confirmed successfully.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.DeleteUserPoolResult deleteUserPool(DeleteUserPoolRequest deleteUserPoolRequest)
Deletes the specified Amazon Cognito user pool.
deleteUserPoolRequest - Represents the request to delete a user pool.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException - This exception is thrown when a user is not authorized.UserImportInProgressException - This exception is thrown when you are trying to modify a user pool while a user import job is in progress
for that pool.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.DeleteUserPoolClientResult deleteUserPoolClient(DeleteUserPoolClientRequest deleteUserPoolClientRequest)
Allows the developer to delete the user pool client.
deleteUserPoolClientRequest - Represents the request to delete a user pool client.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException - This exception is thrown when a user is not authorized.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.DeleteUserPoolDomainResult deleteUserPoolDomain(DeleteUserPoolDomainRequest deleteUserPoolDomainRequest)
Deletes a domain for a user pool.
deleteUserPoolDomainRequest - NotAuthorizedException - This exception is thrown when a user is not authorized.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.DescribeIdentityProviderResult describeIdentityProvider(DescribeIdentityProviderRequest describeIdentityProviderRequest)
Gets information about a specific identity provider.
describeIdentityProviderRequest - InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException - This exception is thrown when a user is not authorized.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.DescribeResourceServerResult describeResourceServer(DescribeResourceServerRequest describeResourceServerRequest)
Describes a resource server.
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.DescribeRiskConfigurationResult describeRiskConfiguration(DescribeRiskConfigurationRequest describeRiskConfigurationRequest)
Describes the risk configuration.
describeRiskConfigurationRequest - 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.UserPoolAddOnNotEnabledException - This exception is thrown when user pool add-ons are not enabled.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.DescribeUserImportJobResult describeUserImportJob(DescribeUserImportJobRequest describeUserImportJobRequest)
Describes the user import job.
describeUserImportJobRequest - Represents the request to describe the user import job.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException - This exception is thrown when a user is not authorized.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.DescribeUserPoolResult describeUserPool(DescribeUserPoolRequest describeUserPoolRequest)
Returns the configuration information and metadata of the specified user pool.
describeUserPoolRequest - Represents the request to describe the user pool.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException - This exception is thrown when a user is not authorized.UserPoolTaggingException - This exception is thrown when a user pool tag cannot be set or updated.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.DescribeUserPoolClientResult describeUserPoolClient(DescribeUserPoolClientRequest describeUserPoolClientRequest)
Client method for returning the configuration information and metadata of the specified user pool app client.
describeUserPoolClientRequest - Represents the request to describe a user pool client.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException - This exception is thrown when a user is not authorized.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.DescribeUserPoolDomainResult describeUserPoolDomain(DescribeUserPoolDomainRequest describeUserPoolDomainRequest)
Gets information about a domain.
describeUserPoolDomainRequest - NotAuthorizedException - This exception is thrown when a user is not authorized.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.ForgetDeviceResult forgetDevice(ForgetDeviceRequest forgetDeviceRequest)
Forgets the specified device.
forgetDeviceRequest - Represents the request to forget the device.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException - This exception is thrown when a user is not authorized.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.InvalidUserPoolConfigurationException - This exception is thrown when the user pool configuration is invalid.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user is not found.UserNotConfirmedException - This exception is thrown when a user is not confirmed successfully.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.ForgotPasswordResult forgotPassword(ForgotPasswordRequest forgotPasswordRequest)
Calling this API causes a message to be sent to the end user with a confirmation code that is required to change
the user's password. 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 .
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.GetCSVHeaderResult getCSVHeader(GetCSVHeaderRequest getCSVHeaderRequest)
Gets the header information for the .csv file to be used as input for the user import job.
getCSVHeaderRequest - Represents the request to get the header information for the .csv file for the user import job.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException - This exception is thrown when a user is not authorized.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.GetDeviceResult getDevice(GetDeviceRequest getDeviceRequest)
Gets the device.
getDeviceRequest - Represents the request to get the device.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.InvalidUserPoolConfigurationException - This exception is thrown when the user pool configuration is invalid.NotAuthorizedException - This exception is thrown when a user is not authorized.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user is not found.UserNotConfirmedException - This exception is thrown when a user is not confirmed successfully.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.GetGroupResult getGroup(GetGroupRequest getGroupRequest)
Gets a group.
Calling this action requires developer credentials.
getGroupRequest - ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException - This exception is thrown when a user is not authorized.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.GetIdentityProviderByIdentifierResult getIdentityProviderByIdentifier(GetIdentityProviderByIdentifierRequest getIdentityProviderByIdentifierRequest)
Gets the specified identity provider.
getIdentityProviderByIdentifierRequest - InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException - This exception is thrown when a user is not authorized.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.GetSigningCertificateResult getSigningCertificate(GetSigningCertificateRequest getSigningCertificateRequest)
This method takes a user pool ID, and returns the signing certificate.
getSigningCertificateRequest - Request to get a signing certificate from Cognito.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.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.GetUICustomizationResult getUICustomization(GetUICustomizationRequest getUICustomizationRequest)
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.
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.GetUserResult getUser(GetUserRequest getUserRequest)
Gets the user attributes and metadata for a user.
getUserRequest - Represents the request to get information about the user.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException - This exception is thrown when a user is not authorized.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user is not found.UserNotConfirmedException - This exception is thrown when a user is not confirmed successfully.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.GetUserAttributeVerificationCodeResult getUserAttributeVerificationCode(GetUserAttributeVerificationCodeRequest getUserAttributeVerificationCodeRequest)
Gets the user attribute verification code for the specified attribute name.
getUserAttributeVerificationCodeRequest - Represents the request to get user attribute verification.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException - This exception is thrown when a user is not authorized.UnexpectedLambdaException - This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.InvalidSmsRoleAccessPolicyException - This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.InvalidEmailRoleAccessPolicyException - This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code:
400.CodeDeliveryFailureException - This exception is thrown when a verification code fails to deliver successfully.LimitExceededException - This exception is thrown when a user exceeds the limit for a requested AWS resource.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user is not found.UserNotConfirmedException - This exception is thrown when a user is not confirmed successfully.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.GetUserPoolMfaConfigResult getUserPoolMfaConfig(GetUserPoolMfaConfigRequest getUserPoolMfaConfigRequest)
Gets the user pool multi-factor authentication (MFA) configuration.
getUserPoolMfaConfigRequest - 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.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.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.GlobalSignOutResult globalSignOut(GlobalSignOutRequest globalSignOutRequest)
Signs out users from all devices. It also invalidates all refresh tokens issued to a user. The user's current access and Id tokens remain valid until their expiry. Access and Id tokens expire one hour after they are issued.
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.InitiateAuthResult initiateAuth(InitiateAuthRequest initiateAuthRequest)
Initiates the authentication flow.
initiateAuthRequest - Initiates the authentication request.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException - This exception is thrown when a user is not authorized.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.UnexpectedLambdaException - This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.InvalidUserPoolConfigurationException - This exception is thrown when the user pool configuration is invalid.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user is not found.UserNotConfirmedException - This exception is thrown when a user is not confirmed successfully.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.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.ListDevicesResult listDevices(ListDevicesRequest listDevicesRequest)
Lists the devices.
listDevicesRequest - Represents the request to list the devices.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException - This exception is thrown when a user is not authorized.InvalidUserPoolConfigurationException - This exception is thrown when the user pool configuration is invalid.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user is not found.UserNotConfirmedException - This exception is thrown when a user is not confirmed successfully.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.ListGroupsResult listGroups(ListGroupsRequest listGroupsRequest)
Lists the groups associated with a user pool.
Calling this action requires developer credentials.
listGroupsRequest - InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException - This exception is thrown when a user is not authorized.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.ListIdentityProvidersResult listIdentityProviders(ListIdentityProvidersRequest listIdentityProvidersRequest)
Lists information about all identity providers for a user pool.
listIdentityProvidersRequest - InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException - This exception is thrown when a user is not authorized.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.ListResourceServersResult listResourceServers(ListResourceServersRequest listResourceServersRequest)
Lists the resource servers for a user pool.
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.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags that are assigned to an Amazon Cognito user pool.
A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
You can use this action up to 10 times per second, per account.
listTagsForResourceRequest - 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.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.ListUserImportJobsResult listUserImportJobs(ListUserImportJobsRequest listUserImportJobsRequest)
Lists the user import jobs.
listUserImportJobsRequest - Represents the request to list the user import jobs.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException - This exception is thrown when a user is not authorized.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.ListUserPoolClientsResult listUserPoolClients(ListUserPoolClientsRequest listUserPoolClientsRequest)
Lists the clients that have been created for the specified user pool.
listUserPoolClientsRequest - Represents the request to list the user pool clients.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException - This exception is thrown when a user is not authorized.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.ListUserPoolsResult listUserPools(ListUserPoolsRequest listUserPoolsRequest)
Lists the user pools associated with an AWS account.
listUserPoolsRequest - Represents the request to list user pools.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException - This exception is thrown when a user is not authorized.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.ListUsersResult listUsers(ListUsersRequest listUsersRequest)
Lists the users in the Amazon Cognito user pool.
listUsersRequest - Represents the request to list users.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException - This exception is thrown when a user is not authorized.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.ListUsersInGroupResult listUsersInGroup(ListUsersInGroupRequest listUsersInGroupRequest)
Lists the users in the specified group.
Calling this action requires developer credentials.
listUsersInGroupRequest - InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.NotAuthorizedException - This exception is thrown when a user is not authorized.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.ResendConfirmationCodeResult resendConfirmationCode(ResendConfirmationCodeRequest resendConfirmationCodeRequest)
Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
resendConfirmationCodeRequest - Represents the request to resend the confirmation code.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnexpectedLambdaException - This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.NotAuthorizedException - This exception is thrown when a user is not authorized.InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.LimitExceededException - This exception is thrown when a user exceeds the limit for a requested AWS resource.InvalidSmsRoleAccessPolicyException - This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.InvalidEmailRoleAccessPolicyException - This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code:
400.CodeDeliveryFailureException - This exception is thrown when a verification code fails to deliver successfully.UserNotFoundException - This exception is thrown when a user is not found.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.RespondToAuthChallengeResult respondToAuthChallenge(RespondToAuthChallengeRequest respondToAuthChallengeRequest)
Responds to the authentication challenge.
respondToAuthChallengeRequest - The request to respond to an authentication challenge.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.NotAuthorizedException - This exception is thrown when a user is not authorized.CodeMismatchException - This exception is thrown if the provided code does not match what the server was expecting.ExpiredCodeException - This exception is thrown if a code has expired.UnexpectedLambdaException - This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.InvalidPasswordException - This exception is thrown when the Amazon Cognito service encounters an invalid password.InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.InvalidUserPoolConfigurationException - This exception is thrown when the user pool configuration is invalid.MFAMethodNotFoundException - This exception is thrown when Amazon Cognito cannot find a multi-factor authentication (MFA) method.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user is not found.UserNotConfirmedException - This exception is thrown when a user is not confirmed successfully.InvalidSmsRoleAccessPolicyException - This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.AliasExistsException - This exception is thrown when a user tries to confirm the account with an email or phone number that has
already been supplied as an alias from a different account. This exception tells user that an account
with this email or phone already exists.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.SoftwareTokenMFANotFoundException - This exception is thrown when the software token TOTP multi-factor authentication (MFA) is not enabled
for the user pool.SetRiskConfigurationResult setRiskConfiguration(SetRiskConfigurationRequest setRiskConfigurationRequest)
Configures actions on detected risks. To delete the risk configuration for UserPoolId or
ClientId, pass null values for all four configuration types.
To enable Amazon Cognito advanced security features, update the user pool to include the
UserPoolAddOns keyAdvancedSecurityMode.
See .
setRiskConfigurationRequest - 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.UserPoolAddOnNotEnabledException - This exception is thrown when user pool add-ons are not enabled.CodeDeliveryFailureException - This exception is thrown when a verification code fails to deliver successfully.InvalidEmailRoleAccessPolicyException - This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code:
400.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.SetUICustomizationResult setUICustomization(SetUICustomizationRequest setUICustomizationRequest)
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.
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.SetUserMFAPreferenceResult setUserMFAPreference(SetUserMFAPreferenceRequest setUserMFAPreferenceRequest)
Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are enabled and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are enabled. If multiple options are enabled and no preference is set, a challenge to choose an MFA option will be returned during sign in.
setUserMFAPreferenceRequest - 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.SetUserPoolMfaConfigResult setUserPoolMfaConfig(SetUserPoolMfaConfigRequest setUserPoolMfaConfigRequest)
Set the user pool multi-factor authentication (MFA) configuration.
setUserPoolMfaConfigRequest - 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.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested 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.NotAuthorizedException - This exception is thrown when a user is not authorized.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.SetUserSettingsResult setUserSettings(SetUserSettingsRequest setUserSettingsRequest)
This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either type of MFA, use the SetUserMFAPreference action instead.
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.SignUpResult signUp(SignUpRequest signUpRequest)
Registers the user in the specified user pool and creates a user name, password, and user attributes.
signUpRequest - Represents the request to register a user.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnexpectedLambdaException - This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.NotAuthorizedException - This exception is thrown when a user is not authorized.InvalidPasswordException - This exception is thrown when the Amazon Cognito service encounters an invalid password.InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.UsernameExistsException - This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.InvalidSmsRoleAccessPolicyException - This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.InvalidEmailRoleAccessPolicyException - This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code:
400.CodeDeliveryFailureException - This exception is thrown when a verification code fails to deliver successfully.StartUserImportJobResult startUserImportJob(StartUserImportJobRequest startUserImportJobRequest)
Starts the user import.
startUserImportJobRequest - Represents the request to start the user import job.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.PreconditionNotMetException - This exception is thrown when a precondition is not met.NotAuthorizedException - This exception is thrown when a user is not authorized.StopUserImportJobResult stopUserImportJob(StopUserImportJobRequest stopUserImportJobRequest)
Stops the user import job.
stopUserImportJobRequest - Represents the request to stop the user import job.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.PreconditionNotMetException - This exception is thrown when a precondition is not met.NotAuthorizedException - This exception is thrown when a user is not authorized.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
Each tag consists of a key and value, both of which you define. A key is a general category for more specific
values. For example, if you have two versions of a user pool, one for testing and another for production, you
might assign an Environment tag key to both user pools. The value of this key might be
Test for one user pool and Production for the other.
Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your user pools. In an IAM policy, you can constrain permissions for user pools based on specific tags or tag values.
You can use this action up to 5 times per second, per account. A user pool can have as many as 50 tags.
tagResourceRequest - 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.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account
untagResourceRequest - 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.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.UpdateAuthEventFeedbackResult updateAuthEventFeedback(UpdateAuthEventFeedbackRequest updateAuthEventFeedbackRequest)
Provides the feedback for an authentication event whether it was from a valid user or not. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.
updateAuthEventFeedbackRequest - 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.UserPoolAddOnNotEnabledException - This exception is thrown when user pool add-ons are not enabled.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.UpdateDeviceStatusResult updateDeviceStatus(UpdateDeviceStatusRequest updateDeviceStatusRequest)
Updates the device status.
updateDeviceStatusRequest - Represents the request to update the device status.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException - This exception is thrown when a user is not authorized.InvalidUserPoolConfigurationException - This exception is thrown when the user pool configuration is invalid.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user is not found.UserNotConfirmedException - This exception is thrown when a user is not confirmed successfully.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.UpdateGroupResult updateGroup(UpdateGroupRequest updateGroupRequest)
Updates the specified group with the specified attributes.
Calling this action requires developer credentials.
If you don't provide a value for an attribute, it will be set to the default value.
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.UpdateIdentityProviderResult updateIdentityProvider(UpdateIdentityProviderRequest updateIdentityProviderRequest)
Updates identity provider information for a user pool.
updateIdentityProviderRequest - InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.UnsupportedIdentityProviderException - This exception is thrown when the specified identifier is not supported.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.NotAuthorizedException - This exception is thrown when a user is not authorized.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.UpdateResourceServerResult updateResourceServer(UpdateResourceServerRequest updateResourceServerRequest)
Updates the name and scopes of resource server. All other fields are read-only.
If you don't provide a value for an attribute, it will be set to the default value.
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.UpdateUserAttributesResult updateUserAttributes(UpdateUserAttributesRequest updateUserAttributesRequest)
Allows a user to update a specific attribute (one at a time).
updateUserAttributesRequest - Represents the request to update user attributes.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.CodeMismatchException - This exception is thrown if the provided code does not match what the server was expecting.ExpiredCodeException - This exception is thrown if a code has expired.NotAuthorizedException - This exception is thrown when a user is not authorized.UnexpectedLambdaException - This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS
Lambda service.UserLambdaValidationException - This exception is thrown when the Amazon Cognito service encounters a user validation exception with the
AWS Lambda service.InvalidLambdaResponseException - This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.AliasExistsException - This exception is thrown when a user tries to confirm the account with an email or phone number that has
already been supplied as an alias from a different account. This exception tells user that an account
with this email or phone already exists.InvalidSmsRoleAccessPolicyException - This exception is returned when the role provided for SMS configuration does not have permission to
publish using Amazon SNS.InvalidSmsRoleTrustRelationshipException - This exception is thrown when the trust relationship is invalid for the role provided for SMS
configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID
provided in the role does not match what is provided in the SMS configuration for the user pool.InvalidEmailRoleAccessPolicyException - This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code:
400.CodeDeliveryFailureException - This exception is thrown when a verification code fails to deliver successfully.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user is not found.UserNotConfirmedException - This exception is thrown when a user is not confirmed successfully.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.UpdateUserPoolResult updateUserPool(UpdateUserPoolRequest updateUserPoolRequest)
Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings with .
If you don't provide a value for an attribute, it will be set to the default value.
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.UpdateUserPoolClientResult updateUserPoolClient(UpdateUserPoolClientRequest updateUserPoolClientRequest)
Updates the specified user pool app client with the specified attributes. You can get a list of the current user pool app client settings with .
If you don't provide a value for an attribute, it will be set to the default value.
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.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.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.UpdateUserPoolDomainResult updateUserPoolDomain(UpdateUserPoolDomainRequest updateUserPoolDomainRequest)
Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.
You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You cannot use it to change the domain for a user pool.
A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and sign-in pages for your application. When you set up a custom domain, you provide a certificate that you manage with AWS Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain.
Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same, and your custom domain uses the new certificate automatically.
However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide this ARN to Amazon Cognito.
When you add your new certificate in ACM, you must choose US East (N. Virginia) as the AWS Region.
After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain.
For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
updateUserPoolDomainRequest - The UpdateUserPoolDomain request input.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.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.VerifySoftwareTokenResult verifySoftwareToken(VerifySoftwareTokenRequest verifySoftwareTokenRequest)
Use this API to register a user's entered TOTP code and mark the user's software token MFA status as "verified" if successful. The request takes an access token or a session string, but not both.
verifySoftwareTokenRequest - 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.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.EnableSoftwareTokenMFAException - This exception is thrown when there is a code mismatch and the service fails to configure the software
token TOTP multi-factor authentication (MFA).NotAuthorizedException - This exception is thrown when a user is not authorized.SoftwareTokenMFANotFoundException - This exception is thrown when the software token TOTP multi-factor authentication (MFA) is not enabled
for the user pool.CodeMismatchException - This exception is thrown if the provided code does not match what the server was expecting.VerifyUserAttributeResult verifyUserAttribute(VerifyUserAttributeRequest verifyUserAttributeRequest)
Verifies the specified user attributes in the user pool.
verifyUserAttributeRequest - Represents the request to verify user attributes.ResourceNotFoundException - This exception is thrown when the Amazon Cognito service cannot find the requested resource.InvalidParameterException - This exception is thrown when the Amazon Cognito service encounters an invalid parameter.CodeMismatchException - This exception is thrown if the provided code does not match what the server was expecting.ExpiredCodeException - This exception is thrown if a code has expired.NotAuthorizedException - This exception is thrown when a user is not authorized.TooManyRequestsException - This exception is thrown when the user has made too many requests for a given operation.LimitExceededException - This exception is thrown when a user exceeds the limit for a requested AWS resource.PasswordResetRequiredException - This exception is thrown when a password reset is required.UserNotFoundException - This exception is thrown when a user is not found.UserNotConfirmedException - This exception is thrown when a user is not confirmed successfully.InternalErrorException - This exception is thrown when Amazon Cognito encounters an internal error.void shutdown()
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 a request.
request - The originally executed request.Copyright © 2020. All rights reserved.