Package-level declarations
Types
The data type for AccountRecoverySetting.
Account takeover actions type.
Account takeover action type.
Configuration for mitigation actions and notification for different levels of risk detected for a potential account takeover.
Represents the request to add custom attributes.
Represents the response from the server for the request to add custom attributes.
Confirm a user's registration as a user pool administrator.
Represents the response from the server for the request to confirm registration.
The configuration for creating a new user profile.
Represents the request to create a user in the specified user pool.
Represents the response from the server to the request to create the user.
Represents the request to delete user attributes as an administrator.
Represents the response received from the server for a request to delete user attributes.
Represents the request to delete a user as an administrator.
Represents the request to disable the user as an administrator.
Represents the response received from the server to disable the user as an administrator.
Represents the request that enables the user as an administrator.
Represents the response from the server for the request to enable a user as an administrator.
Sends the forgot device request, as an administrator.
Represents the request to get the device, as an administrator.
Gets the device response, as an administrator.
Represents the request to get the specified user as an administrator.
Represents the response from the server from the request to get the specified user as an administrator.
Initiates the authorization request, as an administrator.
Initiates the authentication response, as an administrator.
Represents the request to list devices, as an administrator.
Lists the device's response, as an administrator.
Represents the request to reset a user's password as an administrator.
Represents the response from the server to reset a user password as an administrator.
The request to respond to the authentication challenge, as an administrator.
Responds to the authentication challenge, as an administrator.
You can use this parameter to set an MFA configuration that uses the SMS delivery medium.
Represents the response from the server to set user settings as an administrator.
The request to update the device status, as an administrator.
The status response to the request to update the device, as an administrator.
Represents the request to update the user's attributes as an administrator.
Represents the response from the server for the request to update user attributes as an administrator.
The request to sign out of all devices, as an administrator.
The global sign-out response, as an administrator.
This exception is thrown when a user tries to confirm the account with an email address or phone number that has already been supplied as an alias for a different user profile. This exception indicates that an account with this email address or phone already exists in a user pool that you've configured to use email address or phone number as a sign-in alias.
The Amazon Pinpoint analytics configuration necessary to collect metrics for a user pool.
An Amazon Pinpoint analytics endpoint.
Specifies whether the attribute is standard or custom.
The authentication result.
The authentication event type.
The challenge response type.
Represents the request to change a user password.
The response from the server to the change password request.
The CloudWatch logging destination of a user pool detailed activity logging configuration.
The delivery details for an email or SMS message that Amazon Cognito sent for authentication or verification.
This exception is thrown when a verification code fails to deliver successfully.
This exception is thrown if the provided code doesn't match what the server was expecting.
Base class for all service related exceptions thrown by the CognitoIdentityProvider client
The compromised credentials actions type.
The compromised credentials risk configuration type.
This exception is thrown if two or more modifications are happening concurrently.
Confirms the device request.
Confirms the device response.
The request representing the confirmation for a password reset.
The response from the server that results from a user's request to retrieve a forgotten password.
Represents the request to confirm registration of a user.
Represents the response from the server for the registration confirmation.
Contextual user data type used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
Represents the request to create the user import job.
Represents the response from the server to the request to create the user import job.
Represents the request to create a user pool client.
Represents the response from the server to create a user pool client.
Represents the request to create a user pool.
Represents the response from the server for the request to create a user pool.
The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
The properties of a custom email sender Lambda trigger.
The properties of a custom SMS sender Lambda trigger.
Represents the request to delete user attributes.
Represents the response from the server to delete user attributes.
Represents the request to delete a user pool client.
Represents the request to delete a user pool.
Represents the request to delete a user.
Represents the request to describe the user import job.
Represents the response from the server to the request to describe the user import job.
Represents the request to describe a user pool client.
Represents the response from the server from a request to describe the user pool client.
Represents the request to describe the user pool.
Represents the response to describe the user pool.
The device-remembering configuration for a user pool. A DescribeUserPool request returns a null value for this object when the user pool isn't configured to remember devices. When device remembering is active, you can remember a user's device with a ConfirmDevice API request. Additionally. when the property DeviceOnlyRememberedOnUserPrompt is true, you must follow ConfirmDevice with an UpdateDeviceStatus API request that sets the user's device to remembered or not_remembered.
The device verifier against which it is authenticated.
The device type.
A container for information about a domain.
This exception is thrown when the provider is already supported by the user pool.
The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.
This exception is thrown when there is a code mismatch and the service fails to configure the software token TOTP multi-factor authentication (MFA).
Specifies the user context data captured at the time of an event request.
Specifies the event feedback type.
The event risk type.
This exception is thrown if a code has expired.
This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.
Represents the request to forget the device.
Represents the request to reset a user's password.
The response from Amazon Cognito to a request to reset a password.
Represents the request to get the header information of the CSV file for the user import job.
Represents the response from the server to the request to get the header information of the CSV file for the user import job.
Represents the request to get the device.
Gets the device response.
Request to get a signing certificate from Amazon Cognito.
Response from Amazon Cognito for a signing certificate request.
Represents the request to get user attribute verification.
The verification code response returned by the server response to get the user attribute verification code.
Represents the request to get information about the user.
Represents the response from the server from the request to get information about the user.
Represents the request to sign out all devices.
The response to the request to sign out all devices.
This exception is thrown when Amazon Cognito encounters a group that already exists in the user pool.
The HTTP header.
A container for information about an IdP.
Initiates the authentication request.
Initiates the authentication response.
This exception is thrown when Amazon Cognito encounters an internal error.
This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP status code: 400.
This exception is thrown when Amazon Cognito encounters an invalid Lambda response.
This exception is thrown when the specified OAuth flow is not valid.
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
This exception is thrown when Amazon Cognito encounters an invalid password.
This exception is returned when the role provided for SMS configuration doesn't have permission to publish using Amazon SNS.
This exception is thrown when the trust relationship is not valid for the role provided for SMS configuration. This can happen if you don't 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.
This exception is thrown when the user pool configuration is not valid.
Specifies the configuration for Lambda triggers.
This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource.
Represents the request to list the devices.
Represents the response to list devices.
Represents the request to list the user import jobs.
Represents the response from the server to the request to list the user import jobs.
Represents the request to list the user pool clients.
Represents the response from the server that lists user pool clients.
Represents the request to list user pools.
Represents the response to list user pools.
Represents the request to list users.
The response from the request to list users.
The logging parameters of a user pool.
The logging parameters of a user pool.
The message template structure.
This exception is thrown when Amazon Cognito can't find a multi-factor authentication (MFA) method.
This data type is no longer supported. Applies only to SMS multi-factor authentication (MFA) configurations. Does not apply to time-based one-time password (TOTP) software token MFA configurations.
The new device metadata type.
This exception is thrown when a user isn't authorized.
The notify configuration type.
The notify email type.
The minimum and maximum values of an attribute that is of the number data type.
The password policy type.
This exception is thrown when a password reset is required.
This exception is thrown when a precondition is not met.
The properties of a pre token generation Lambda trigger.
A container for IdP details.
A container for information about an IdP for a user pool.
A map containing a priority as a key, and recovery method name as a value.
Represents the request to resend the confirmation code.
The response from the server when Amazon Cognito makes the request to resend a confirmation code.
This exception is thrown when the Amazon Cognito service can't find the requested resource.
A resource server scope.
A container for information about a resource server for a user pool.
The request to respond to an authentication challenge.
The response to respond to the authentication challenge.
The risk configuration type.
The type of the configuration to override the risk decision.
A list of the user attributes and their properties in your user pool. The attribute schema contains standard attributes, custom attributes with a custom: prefix, and developer attributes with a dev: prefix. For more information, see User pool attributes.
This exception is thrown when the specified scope doesn't exist.
Represents the request to set user settings.
The response from the server for a set user settings request.
Represents the request to register a user.
The response from the server for a registration request.
The SMS configuration type is the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
The SMS text message multi-factor authentication (MFA) configuration type.
The type used for enabling SMS multi-factor authentication (MFA) at the user level. Phone numbers don't need to be verified to be used for SMS MFA. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted. If you would like MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool.
The type used for enabling software token MFA at the user pool level.
This exception is thrown when the software token time-based one-time password (TOTP) multi-factor authentication (MFA) isn't activated for the user pool.
The type used for enabling software token MFA at the user level. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted. If you want MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool.
Represents the request to start the user import job.
Represents the response from the server to the request to start the user import job.
Represents the request to stop the user import job.
Represents the response from the server to the request to stop the user import job.
The constraints associated with a string attribute.
The data type TokenValidityUnits specifies the time units you use when you set the duration of ID, access, and refresh tokens.
This exception is thrown when the user has made too many failed attempts for a given action, such as sign-in.
This exception is thrown when the user has made too many requests for a given operation.
A container for the UI customization information for a user pool's built-in app UI.
Exception that is thrown when the request isn't authorized. This can happen due to an invalid access token in the request.
This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.
This exception is thrown when the specified identifier isn't supported.
Exception that is thrown when you attempt to perform an operation that isn't enabled for the user pool client.
Exception that is thrown when an unsupported token is passed to an operation.
The request failed because the user is in an unsupported state.
Represents the request to update the device status.
The response to the request to update the device status.
Represents the request to update user attributes.
Represents the response from the server for the request to update user attributes.
Represents the request to update the user pool client.
Represents the response from the server to the request to update the user pool client.
The UpdateUserPoolDomain request input.
The UpdateUserPoolDomain response output.
Represents the request to update the user pool.
Represents the response from the server when you make a request to update the user pool.
The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.
Contextual data, such as the user's device fingerprint, IP address, or location, used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
This exception is thrown when you're trying to modify a user pool while a user import job is in progress for that pool.
The user import job type.
This exception is thrown when the Amazon Cognito service encounters a user validation exception with the Lambda service.
The username configuration type.
This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.
This exception is thrown when a user isn't confirmed successfully.
This exception is thrown when a user isn't found.
This exception is thrown when user pool add-ons aren't enabled.
User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.
The description of the user pool client.
Contains information about a user pool client.
A user pool description.
The policy associated with a user pool.
This exception is thrown when a user pool tag can't be set or updated.
A container for information about the user pool.
The template for verification messages.
Represents the request to verify user attributes.
A container representing the response from the server from the request to verify user attributes.