A recovery option for a user. The AccountRecoverySettingType data type is
* an array of this object. Each RecoveryOptionType has a priority property
* that determines whether it is a primary or secondary option.
For example, if verified_email has a priority of 1 and
* verified_phone_number has a priority of 2, your user pool
* sends account-recovery messages to a verified email address but falls back to an SMS
* message if the user has a verified phone number. The admin_only option
* prevents self-service account recovery.
This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.
* @public */ export interface RecoveryOptionType { /** *Your priority preference for using the specified attribute in account recovery. The
* highest priority is 1.
The recovery method that this object sets a recovery option for.
* @public */ Name: RecoveryOptionNameType | undefined; } /** *The settings for user message delivery in forgot-password operations. Contains * preference for email or SMS message delivery of password reset codes, or for admin-only * password reset.
*This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.
* @public */ export interface AccountRecoverySettingType { /** *The list of options and priorities for user message delivery in forgot-password * operations. Sets or displays user pool preferences for email or SMS message priority, * whether users should fall back to a second delivery method, and whether passwords should * only be reset by administrators.
* @public */ RecoveryMechanisms?: RecoveryOptionType[] | undefined; } /** * @public * @enum */ export declare const AccountTakeoverEventActionType: { readonly BLOCK: "BLOCK"; readonly MFA_IF_CONFIGURED: "MFA_IF_CONFIGURED"; readonly MFA_REQUIRED: "MFA_REQUIRED"; readonly NO_ACTION: "NO_ACTION"; }; /** * @public */ export type AccountTakeoverEventActionType = (typeof AccountTakeoverEventActionType)[keyof typeof AccountTakeoverEventActionType]; /** *The automated response to a risk level for adaptive authentication in full-function,
* or ENFORCED, mode. You can assign an action to each risk level that
* advanced security features evaluates.
This data type is a request parameter of SetRiskConfiguration and a response parameter of DescribeRiskConfiguration.
* @public */ export interface AccountTakeoverActionType { /** *Determines whether Amazon Cognito sends a user a notification message when your user pools * assesses a user's session at the associated risk level.
* @public */ Notify: boolean | undefined; /** *The action to take for the attempted account takeover action for the associated risk * level. Valid values are as follows:
*
* BLOCK: Block the request.
* MFA_IF_CONFIGURED: Present an MFA challenge if possible. MFA is
* possible if the user pool has active MFA methods that the user can set up. For
* example, if the user pool only supports SMS message MFA but the user
* doesn't have a phone number attribute, MFA setup isn't possible. If MFA
* setup isn't possible, allow the request.
* MFA_REQUIRED: Present an MFA challenge if possible. Block the
* request if a user hasn't set up MFA. To sign in with required MFA, users must
* have an email address or phone number attribute, or a registered TOTP
* factor.
* NO_ACTION: Take no action. Permit sign-in.
A list of account-takeover actions for each level of risk that Amazon Cognito might assess with * advanced security features.
*This data type is a request parameter of SetRiskConfiguration and a response parameter of DescribeRiskConfiguration.
* @public */ export interface AccountTakeoverActionsType { /** *The action that you assign to a low-risk assessment by advanced security * features.
* @public */ LowAction?: AccountTakeoverActionType | undefined; /** *The action that you assign to a medium-risk assessment by advanced security * features.
* @public */ MediumAction?: AccountTakeoverActionType | undefined; /** *The action that you assign to a high-risk assessment by advanced security * features.
* @public */ HighAction?: AccountTakeoverActionType | undefined; } /** *The template for email messages that advanced security features sends to a user when * your threat protection automated response has a Notify * action.
*This data type is a request parameter of SetRiskConfiguration and a response parameter of DescribeRiskConfiguration.
* @public */ export interface NotifyEmailType { /** *The subject of the threat protection email notification.
* @public */ Subject: string | undefined; /** *The body of an email notification formatted in HTML. Choose an HtmlBody
* or a TextBody to send an HTML-formatted or plaintext message,
* respectively.
The body of an email notification formatted in plaintext. Choose an
* HtmlBody or a TextBody to send an HTML-formatted or
* plaintext message, respectively.
The configuration for Amazon SES email messages that advanced security features sends to a * user when your adaptive authentication automated response has a * Notify action.
*This data type is a request parameter of SetRiskConfiguration and a response parameter of DescribeRiskConfiguration.
* @public */ export interface NotifyConfigurationType { /** *The email address that sends the email message. The address must be either * individually verified with Amazon Simple Email Service, or from a domain that has been verified with * Amazon SES.
* @public */ From?: string | undefined; /** *The reply-to email address of an email template.
* @public */ ReplyTo?: string | undefined; /** *The Amazon Resource Name (ARN) of the identity that is associated with the sending
* authorization policy. This identity permits Amazon Cognito to send for the email address
* specified in the From parameter.
The template for the email message that your user pool sends when a detected risk * event is blocked.
* @public */ BlockEmail?: NotifyEmailType | undefined; /** *The template for the email message that your user pool sends when no action is taken * in response to a detected risk.
* @public */ NoActionEmail?: NotifyEmailType | undefined; /** *The template for the email message that your user pool sends when MFA is challenged in * response to a detected risk.
* @public */ MfaEmail?: NotifyEmailType | undefined; } /** *The settings for automated responses and notification templates for adaptive * authentication with advanced security features.
*This data type is a request parameter of SetRiskConfiguration and a response parameter of DescribeRiskConfiguration.
* @public */ export interface AccountTakeoverRiskConfigurationType { /** *The settings for composing and sending an email message when advanced security
* features assesses a risk level with adaptive authentication. When you choose to notify
* users in AccountTakeoverRiskConfiguration, Amazon Cognito sends an email message
* using the method and template that you set with this data type.
A list of account-takeover actions for each level of risk that Amazon Cognito might assess with * advanced security features.
* @public */ Actions: AccountTakeoverActionsType | undefined; } /** * @public * @enum */ export declare const AttributeDataType: { readonly BOOLEAN: "Boolean"; readonly DATETIME: "DateTime"; readonly NUMBER: "Number"; readonly STRING: "String"; }; /** * @public */ export type AttributeDataType = (typeof AttributeDataType)[keyof typeof AttributeDataType]; /** *The minimum and maximum values of an attribute that is of the number type, for example
* custom:age.
This data type is part of SchemaAttributeType. It defines the length constraints * on number-type attributes that you configure in CreateUserPool and UpdateUserPool, and displays the length constraints of * all number-type attributes in the response to DescribeUserPool *
* @public */ export interface NumberAttributeConstraintsType { /** *The minimum value of an attribute that is of the number data type.
* @public */ MinValue?: string | undefined; /** *The maximum length of a number attribute value. Must be a number less than or equal to
* 2^1023, represented as a string with a length of 131072 characters or
* fewer.
The minimum and maximum length values of an attribute that is of the string type, for
* example custom:department.
This data type is part of SchemaAttributeType. It defines the length constraints * on string-type attributes that you configure in CreateUserPool and UpdateUserPool, and displays the length constraints of * all string-type attributes in the response to DescribeUserPool *
* @public */ export interface StringAttributeConstraintsType { /** *The minimum length of a string attribute value.
* @public */ MinLength?: string | undefined; /** *The maximum length of a string attribute value. Must be a number less than or equal to
* 2^1023, represented as a string with a length of 131072 characters or
* fewer.
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.
Developer-only dev: attributes are a legacy feature of user pools, and
* are read-only to all app clients. You can create and update developer-only attributes
* only with IAM-authenticated API operations. Use app client read/write permissions
* instead.
This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.
* @public */ export interface SchemaAttributeType { /** *The name of your user pool attribute. When you create or update a user pool, adding a
* schema attribute creates a custom or developer-only attribute. When you add an attribute
* with a Name value of MyAttribute, Amazon Cognito creates the custom
* attribute custom:MyAttribute. When DeveloperOnlyAttribute is
* true, Amazon Cognito creates your attribute as dev:MyAttribute. In
* an operation that describes a user pool, Amazon Cognito returns this value as value
* for standard attributes, custom:value for custom attributes, and
* dev:value for developer-only attributes..
The data format of the values for your attribute. When you choose an
* AttributeDataType, Amazon Cognito validates the input against the data type. A
* custom attribute value in your user's ID token is always a string, for example
* "custom:isMember" : "true" or "custom:YearsAsMember" :
* "12".
You should use WriteAttributes in the user pool client to control how attributes can
* be mutated for new use cases instead of using
* DeveloperOnlyAttribute.
Specifies whether the attribute type is developer only. This attribute can only be
* modified by an administrator. Users won't be able to modify this attribute using their
* access token. For example, DeveloperOnlyAttribute can be modified using
* AdminUpdateUserAttributes but can't be updated using UpdateUserAttributes.
Specifies whether the value of the attribute can be changed.
*Any user pool attribute whose value you map from an IdP attribute must be mutable,
* with a parameter value of true. Amazon Cognito updates mapped attributes when users
* sign in to your application through an IdP. If an attribute is immutable, Amazon Cognito throws
* an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User
* Pool.
Specifies whether a user pool attribute is required. If the attribute is required and * the user doesn't provide a value, registration or sign-in will fail.
* @public */ Required?: boolean | undefined; /** *Specifies the constraints for an attribute of the number type.
* @public */ NumberAttributeConstraints?: NumberAttributeConstraintsType | undefined; /** *Specifies the constraints for an attribute of the string type.
* @public */ StringAttributeConstraints?: StringAttributeConstraintsType | undefined; } /** *Represents the request to add custom attributes.
* @public */ export interface AddCustomAttributesRequest { /** *The user pool ID for the user pool where you want to add custom attributes.
* @public */ UserPoolId: string | undefined; /** *An array of custom attributes, such as Mutable and Name.
* @public */ CustomAttributes: SchemaAttributeType[] | undefined; } /** *Represents the response from the server for the request to add custom * attributes.
* @public */ export interface AddCustomAttributesResponse { } /** *This exception is thrown when Amazon Cognito encounters an internal error.
* @public */ export declare class InternalErrorException extends __BaseException { readonly name: "InternalErrorException"; readonly $fault: "server"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThis exception is thrown when the Amazon Cognito service encounters an invalid * parameter.
* @public */ export declare class InvalidParameterException extends __BaseException { readonly name: "InvalidParameterException"; readonly $fault: "client"; /** *The reason code of the exception.
* @public */ reasonCode?: string | undefined; /** * @internal */ constructor(opts: __ExceptionOptionTypeThis exception is thrown when a user isn't authorized.
* @public */ export declare class NotAuthorizedException extends __BaseException { readonly name: "NotAuthorizedException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThis exception is thrown when the Amazon Cognito service can't find the requested * resource.
* @public */ export declare class ResourceNotFoundException extends __BaseException { readonly name: "ResourceNotFoundException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThis exception is thrown when the user has made too many requests for a given * operation.
* @public */ export declare class TooManyRequestsException extends __BaseException { readonly name: "TooManyRequestsException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThis exception is thrown when you're trying to modify a user pool while a user import * job is in progress for that pool.
* @public */ export declare class UserImportInProgressException extends __BaseException { readonly name: "UserImportInProgressException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe user pool ID for the user pool.
* @public */ UserPoolId: string | undefined; /** *The username of the user that you want to query or modify. The value of this parameter
* is typically your user's username, but it can be any of their alias attributes. If
* username isn't an alias attribute in your user pool, this value
* must be the sub of a local user or the username of a user from a
* third-party IdP.
The name of the group that you want to add your user to.
* @public */ GroupName: string | undefined; } /** *This exception is thrown when a user isn't found.
* @public */ export declare class UserNotFoundException extends __BaseException { readonly name: "UserNotFoundException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeConfirm a user's registration as a user pool administrator.
* @public */ export interface AdminConfirmSignUpRequest { /** *The user pool ID for which you want to confirm user registration.
* @public */ UserPoolId: string | undefined; /** *The username of the user that you want to query or modify. The value of this parameter
* is typically your user's username, but it can be any of their alias attributes. If
* username isn't an alias attribute in your user pool, this value
* must be the sub of a local user or the username of a user from a
* third-party IdP.
A map of custom key-value pairs that you can provide as input for any custom workflows * that this action triggers.
*If your user pool configuration includes triggers, the AdminConfirmSignUp API action
* invokes the Lambda function that is specified for the post
* confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON
* payload, which the function receives as input. In this payload, the
* clientMetadata attribute provides the data that you assigned to the
* ClientMetadata parameter in your AdminConfirmSignUp request. In your function code in
* Lambda, you can process the ClientMetadata value to enhance your workflow for your
* specific needs.
For more information, see * Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
*When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the * following:
*Store the ClientMetadata value. This data is available only to Lambda * triggers that are assigned to a user pool to support custom workflows. If * your user pool configuration doesn't include triggers, the ClientMetadata * parameter serves no purpose.
*Validate the ClientMetadata value.
*Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive * information.
*Represents the response from the server for the request to confirm * registration.
* @public */ export interface AdminConfirmSignUpResponse { } /** *This exception is thrown when Amazon Cognito encounters an invalid Lambda response.
* @public */ export declare class InvalidLambdaResponseException extends __BaseException { readonly name: "InvalidLambdaResponseException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThis exception is thrown when a user exceeds the limit for a requested Amazon Web Services * resource.
* @public */ export declare class LimitExceededException extends __BaseException { readonly name: "LimitExceededException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThis exception is thrown when the user has made too many failed attempts for a given * action, such as sign-in.
* @public */ export declare class TooManyFailedAttemptsException extends __BaseException { readonly name: "TooManyFailedAttemptsException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThis exception is thrown when Amazon Cognito encounters an unexpected exception with * Lambda.
* @public */ export declare class UnexpectedLambdaException extends __BaseException { readonly name: "UnexpectedLambdaException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThis exception is thrown when the Amazon Cognito service encounters a user validation exception * with the Lambda service.
* @public */ export declare class UserLambdaValidationException extends __BaseException { readonly name: "UserLambdaValidationException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe name and value of a user attribute.
*This data type is a request parameter of AdminUpdateUserAttributes and UpdateUserAttributes.
* @public */ export interface AttributeType { /** *The name of the attribute.
* @public */ Name: string | undefined; /** *The value of the attribute.
* @public */ Value?: string | undefined; } /** *Creates a new user in the specified user pool.
* @public */ export interface AdminCreateUserRequest { /** *The user pool ID for the user pool where the user will be created.
* @public */ UserPoolId: string | undefined; /** *The value that you want to set as the username sign-in attribute. The following * conditions apply to the username parameter.
*The username can't be a duplicate of another username in the same user * pool.
*You can't change the value of a username after you create it.
*You can only provide a value if usernames are a valid sign-in attribute for * your user pool. If your user pool only supports phone numbers or email addresses * as sign-in attributes, Amazon Cognito automatically generates a username value. For more * information, see Customizing sign-in attributes.
*An array of name-value pairs that contain user attributes and attribute values to be
* set for the user to be created. You can create a user without specifying any attributes
* other than Username. However, any attributes that you specify as required
* (when creating a user pool or in the Attributes tab of
* the console) either you should supply (in your call to AdminCreateUser) or
* the user should supply (when they sign up in response to your welcome message).
For custom attributes, you must prepend the custom: prefix to the
* attribute name.
To send a message inviting the user to sign up, you must specify the user's email * address or phone number. You can do this in your call to AdminCreateUser or in the * Users tab of the Amazon Cognito console for managing your * user pools.
*You must also provide an email address or phone number when you expect the user to do
* passwordless sign-in with an email or SMS OTP. These attributes must be provided when
* passwordless options are the only available, or when you don't submit a
* TemporaryPassword.
In your call to AdminCreateUser, you can set the
* email_verified attribute to True, and you can set the
* phone_number_verified attribute to True. You can also do
* this by calling AdminUpdateUserAttributes.
* email: The email address of the user to whom
* the message that contains the code and username will be sent. Required if the
* email_verified attribute is set to True, or if
* "EMAIL" is specified in the DesiredDeliveryMediums
* parameter.
* phone_number: The phone number of the user to
* whom the message that contains the code and username will be sent. Required if
* the phone_number_verified attribute is set to True, or
* if "SMS" is specified in the DesiredDeliveryMediums
* parameter.
Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda * trigger. This set of key-value pairs are for custom validation of information that you * collect from your users but don't need to retain.
*Your Lambda function can analyze this additional data and act on it. Your function * might perform external API operations like logging user attributes and validation data * to Amazon CloudWatch Logs. Validation data might also affect the response that your function returns * to Amazon Cognito, like automatically confirming the user if they sign up from within your * network.
*For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger.
* @public */ ValidationData?: AttributeType[] | undefined; /** *The user's temporary password. This password must conform to the password policy that * you specified when you created the user pool.
*The exception to the requirement for a password is when your user pool supports * passwordless sign-in with email or SMS OTPs. To create a user with no password, omit * this parameter or submit a blank value. You can only create a passwordless user when * passwordless sign-in is available. See the SignInPolicyType property of CreateUserPool and UpdateUserPool.
*The temporary password is valid only once. To complete the Admin Create User flow, the * user must enter the temporary password in the sign-in page, along with a new password to * be used in all future sign-ins.
*If you don't specify a value, Amazon Cognito generates one for you unless you have passwordless * options active for your user pool.
*The temporary password can only be used until the user account expiration limit that
* you set for your user pool. To reset the account after that time limit, you must call
* AdminCreateUser again and specify RESEND for the
* MessageAction parameter.
This parameter is used only if the phone_number_verified or
* email_verified attribute is set to True. Otherwise, it is
* ignored.
If this parameter is set to True and the phone number or email address
* specified in the UserAttributes parameter already exists as an alias with a different
* user, the API call will migrate the alias from the previous user to the newly created
* user. The previous user will no longer be able to log in using that alias.
If this parameter is set to False, the API throws an
* AliasExistsException error if the alias already exists. The default
* value is False.
Set to RESEND to resend the invitation message to a user that already
* exists and reset the expiration limit on the user's account. Set to
* SUPPRESS to suppress sending the message. You can specify only one
* value.
Specify "EMAIL" if email will be used to send the welcome message.
* Specify "SMS" if the phone number will be used. The default value is
* "SMS". You can specify more than one value.
A map of custom key-value pairs that you can provide as input for any custom workflows * that this action triggers.
*You create custom workflows by assigning Lambda functions to user pool triggers.
* When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned
* to the pre sign-up trigger. When Amazon Cognito invokes this function, it
* passes a JSON payload, which the function receives as input. This payload contains a
* clientMetadata attribute, which provides the data that you assigned to
* the ClientMetadata parameter in your AdminCreateUser request. In your function code in
* Lambda, you can process the clientMetadata value to enhance your
* workflow for your specific needs.
For more information, see * Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
*When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the * following:
*Store the ClientMetadata value. This data is available only to Lambda * triggers that are assigned to a user pool to support custom workflows. If * your user pool configuration doesn't include triggers, the ClientMetadata * parameter serves no purpose.
*Validate the ClientMetadata value.
*Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive * information.
** 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.
* @public */ export interface MFAOptionType { /** *The delivery medium to send the MFA code. You can use this parameter to set only the
* SMS delivery medium value.
The attribute name of the MFA option type. The only valid value is
* phone_number.
A user profile in a Amazon Cognito user pool.
*This data type is a response parameter to AdminCreateUser and ListUsers.
* @public */ export interface UserType { /** *The user's username.
* @public */ Username?: string | undefined; /** *Names and values of a user's attributes, for example email.
The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
* human-readable format like ISO 8601 or a Java Date object.
The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
* human-readable format like ISO 8601 or a Java Date object.
Indicates whether the user's account is enabled or disabled.
* @public */ Enabled?: boolean | undefined; /** *The user status. This can be one of the following:
*UNCONFIRMED - User has been created but not confirmed.
*CONFIRMED - User has been confirmed.
*EXTERNAL_PROVIDER - User signed in with a third-party IdP.
*UNKNOWN - User status isn't known.
*RESET_REQUIRED - User is confirmed, but the user must request a code and reset * their password before they can sign in.
*FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a * temporary password, but on first sign-in, the user must change their password to * a new value before doing anything else.
*The user's MFA configuration.
* @public */ MFAOptions?: MFAOptionType[] | undefined; } /** *Represents the response from the server to the request to create the user.
* @public */ export interface AdminCreateUserResponse { /** *The newly created user.
* @public */ User?: UserType | undefined; } /** *This exception is thrown when a verification code fails to deliver * successfully.
* @public */ export declare class CodeDeliveryFailureException extends __BaseException { readonly name: "CodeDeliveryFailureException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThis exception is thrown when Amazon Cognito encounters an invalid password.
* @public */ export declare class InvalidPasswordException extends __BaseException { readonly name: "InvalidPasswordException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThis exception is returned when the role provided for SMS configuration doesn't have * permission to publish using Amazon SNS.
* @public */ export declare class InvalidSmsRoleAccessPolicyException extends __BaseException { readonly name: "InvalidSmsRoleAccessPolicyException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThis 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 a precondition is not met.
* @public */ export declare class PreconditionNotMetException extends __BaseException { readonly name: "PreconditionNotMetException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe request failed because the user is in an unsupported state.
* @public */ export declare class UnsupportedUserStateException extends __BaseException { readonly name: "UnsupportedUserStateException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThis exception is thrown when Amazon Cognito encounters a user name that already * exists in the user pool.
* @public */ export declare class UsernameExistsException extends __BaseException { readonly name: "UsernameExistsException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe message template structure.
* @public */ export interface MessageTemplateType { /** *The message template for SMS messages.
* @public */ SMSMessage?: string | undefined; /** *The message template for email messages. EmailMessage is allowed only if EmailSendingAccount is DEVELOPER.
* @public */ EmailMessage?: string | undefined; /** *The subject line for email messages. EmailSubject is allowed only if EmailSendingAccount is DEVELOPER.
* @public */ EmailSubject?: string | undefined; } /** *The settings for administrator creation of users in a user pool. Contains settings for * allowing user sign-up, customizing invitation messages to new users, and the amount of * time before temporary passwords expire.
*This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.
* @public */ export interface AdminCreateUserConfigType { /** *The setting for allowing self-service sign-up. When true, only
* administrators can create new user profiles. When false, users can register
* themselves and create a new user profile with the SignUp operation.
This parameter is no longer in use. Configure the duration of temporary passwords with
* the TemporaryPasswordValidityDays parameter of PasswordPolicyType. For older user pools that have a
* UnusedAccountValidityDays configuration, that value is effective until
* you set a value for TemporaryPasswordValidityDays.
The password expiration limit in days for administrator-created users. When this time
* expires, the user can't sign in with their temporary password. To reset the account
* after that time limit, you must call AdminCreateUser again, specifying
* RESEND for the MessageAction parameter.
The default value for this parameter is 7.
* @public */ UnusedAccountValidityDays?: number | undefined; /** *The template for the welcome message to new users. This template must include the
* \{####\} temporary password placeholder if you are creating users with
* passwords. If your users don't have passwords, you can omit the placeholder.
See also Customizing User Invitation Messages.
* @public */ InviteMessageTemplate?: MessageTemplateType | undefined; } /** *Represents the request to delete a user as an administrator.
* @public */ export interface AdminDeleteUserRequest { /** *The user pool ID for the user pool where you want to delete the user.
* @public */ UserPoolId: string | undefined; /** *The username of the user that you want to query or modify. The value of this parameter
* is typically your user's username, but it can be any of their alias attributes. If
* username isn't an alias attribute in your user pool, this value
* must be the sub of a local user or the username of a user from a
* third-party IdP.
Represents the request to delete user attributes as an administrator.
* @public */ export interface AdminDeleteUserAttributesRequest { /** *The user pool ID for the user pool where you want to delete user attributes.
* @public */ UserPoolId: string | undefined; /** *The username of the user that you want to query or modify. The value of this parameter
* is typically your user's username, but it can be any of their alias attributes. If
* username isn't an alias attribute in your user pool, this value
* must be the sub of a local user or the username of a user from a
* third-party IdP.
An array of strings representing the user attribute names you want to delete.
*For custom attributes, you must prepend the custom: prefix to the
* attribute name.
Represents the response received from the server for a request to delete user * attributes.
* @public */ export interface AdminDeleteUserAttributesResponse { } /** *The characteristics of a source or destination user for linking a federated user * profile to a local user profile.
*This data type is a request parameter of AdminLinkProviderForUser and AdminDisableProviderForUser.
* @public */ export interface ProviderUserIdentifierType { /** *The name of the provider, such as Facebook, Google, or Login with Amazon.
* @public */ ProviderName?: string | undefined; /** *The name of the provider attribute to link to, such as NameID.
The value of the provider attribute to link to, such as
* xxxxx_account.
The user pool ID for the user pool.
* @public */ UserPoolId: string | undefined; /** *The user to be disabled.
* @public */ User: ProviderUserIdentifierType | undefined; } /** * @public */ export interface AdminDisableProviderForUserResponse { } /** *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.
* @public */ export declare class AliasExistsException extends __BaseException { readonly name: "AliasExistsException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeRepresents the request to disable the user as an administrator.
* @public */ export interface AdminDisableUserRequest { /** *The user pool ID for the user pool where you want to disable the user.
* @public */ UserPoolId: string | undefined; /** *The username of the user that you want to query or modify. The value of this parameter
* is typically your user's username, but it can be any of their alias attributes. If
* username isn't an alias attribute in your user pool, this value
* must be the sub of a local user or the username of a user from a
* third-party IdP.
Represents the response received from the server to disable the user as an * administrator.
* @public */ export interface AdminDisableUserResponse { } /** *Represents the request that enables the user as an administrator.
* @public */ export interface AdminEnableUserRequest { /** *The user pool ID for the user pool where you want to enable the user.
* @public */ UserPoolId: string | undefined; /** *The username of the user that you want to query or modify. The value of this parameter
* is typically your user's username, but it can be any of their alias attributes. If
* username isn't an alias attribute in your user pool, this value
* must be the sub of a local user or the username of a user from a
* third-party IdP.
Represents the response from the server for the request to enable a user as an * administrator.
* @public */ export interface AdminEnableUserResponse { } /** *Sends the forgot device request, as an administrator.
* @public */ export interface AdminForgetDeviceRequest { /** *The user pool ID.
* @public */ UserPoolId: string | undefined; /** *The username of the user that you want to query or modify. The value of this parameter
* is typically your user's username, but it can be any of their alias attributes. If
* username isn't an alias attribute in your user pool, this value
* must be the sub of a local user or the username of a user from a
* third-party IdP.
The device key.
* @public */ DeviceKey: string | undefined; } /** *This exception is thrown when the user pool configuration is not valid.
* @public */ export declare class InvalidUserPoolConfigurationException extends __BaseException { readonly name: "InvalidUserPoolConfigurationException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeRepresents the request to get the device, as an administrator.
* @public */ export interface AdminGetDeviceRequest { /** *The device key.
* @public */ DeviceKey: string | undefined; /** *The user pool ID.
* @public */ UserPoolId: string | undefined; /** *The username of the user that you want to query or modify. The value of this parameter
* is typically your user's username, but it can be any of their alias attributes. If
* username isn't an alias attribute in your user pool, this value
* must be the sub of a local user or the username of a user from a
* third-party IdP.
Information about a user's device that they've registered for device SRP * authentication in your application. For more information, see Working with user devices in your user pool.
*The data type is a response parameter of AdminGetDevice, AdminListDevices, and GetDevice.
* @public */ export interface DeviceType { /** *The device key, for example
* us-west-2_EXAMPLE-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
Metadata about a user's device, like name and last-access source IP.
* @public */ DeviceAttributes?: AttributeType[] | undefined; /** *The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
* human-readable format like ISO 8601 or a Java Date object.
The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
* human-readable format like ISO 8601 or a Java Date object.
The date when the user last signed in with the device.
* @public */ DeviceLastAuthenticatedDate?: Date | undefined; } /** *Gets the device response, as an administrator.
* @public */ export interface AdminGetDeviceResponse { /** *The device.
* @public */ Device: DeviceType | undefined; } /** *Represents the request to get the specified user as an administrator.
* @public */ export interface AdminGetUserRequest { /** *The user pool ID for the user pool where you want to get information about the * user.
* @public */ UserPoolId: string | undefined; /** *The username of the user that you want to query or modify. The value of this parameter
* is typically your user's username, but it can be any of their alias attributes. If
* username isn't an alias attribute in your user pool, this value
* must be the sub of a local user or the username of a user from a
* third-party IdP.
Represents the response from the server from the request to get the specified user as * an administrator.
* @public */ export interface AdminGetUserResponse { /** *The username of the user that you requested.
* @public */ Username: string | undefined; /** *An array of name-value pairs representing user attributes.
* @public */ UserAttributes?: AttributeType[] | undefined; /** *The date the user was created.
* @public */ UserCreateDate?: Date | undefined; /** *The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
* human-readable format like ISO 8601 or a Java Date object.
Indicates that the status is enabled.
The user status. Can be one of the following:
*UNCONFIRMED - User has been created but not confirmed.
*CONFIRMED - User has been confirmed.
*UNKNOWN - User status isn't known.
*RESET_REQUIRED - User is confirmed, but the user must request a code and reset * their password before they can sign in.
*FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a * temporary password, but on first sign-in, the user must change their password to * a new value before doing anything else.
** This response parameter is no longer supported. It provides * information only about SMS MFA configurations. It doesn't provide information about * time-based one-time password (TOTP) software token MFA configurations. To look up * information about either type of MFA configuration, use UserMFASettingList * instead.
* @public */ MFAOptions?: MFAOptionType[] | undefined; /** *The user's preferred MFA setting.
* @public */ PreferredMfaSetting?: string | undefined; /** *The MFA options that are activated for the user. The possible values in this list are
* SMS_MFA, EMAIL_OTP, and
* SOFTWARE_TOKEN_MFA.
Information that your application adds to authentication requests. Applies an endpoint * ID to the analytics data that your user pool sends to Amazon Pinpoint.
*An endpoint ID uniquely identifies a mobile device, email address or phone number that * can receive messages from Amazon Pinpoint analytics. For more information about Amazon Web Services Regions that * can contain Amazon Pinpoint resources for use with Amazon Cognito user pools, see Using Amazon Pinpoint analytics with Amazon Cognito user pools.
*This data type is a request parameter of authentication operations like InitiateAuth, AdminInitiateAuth, RespondToAuthChallenge, and AdminRespondToAuthChallenge.
* @public */ export interface AnalyticsMetadataType { /** *The endpoint ID. Information that you want to pass to Amazon Pinpoint about where to send * notifications.
* @public */ AnalyticsEndpointId?: string | undefined; } /** * @public * @enum */ export declare const AuthFlowType: { readonly ADMIN_NO_SRP_AUTH: "ADMIN_NO_SRP_AUTH"; readonly ADMIN_USER_PASSWORD_AUTH: "ADMIN_USER_PASSWORD_AUTH"; readonly CUSTOM_AUTH: "CUSTOM_AUTH"; readonly REFRESH_TOKEN: "REFRESH_TOKEN"; readonly REFRESH_TOKEN_AUTH: "REFRESH_TOKEN_AUTH"; readonly USER_AUTH: "USER_AUTH"; readonly USER_PASSWORD_AUTH: "USER_PASSWORD_AUTH"; readonly USER_SRP_AUTH: "USER_SRP_AUTH"; }; /** * @public */ export type AuthFlowType = (typeof AuthFlowType)[keyof typeof AuthFlowType]; /** *The HTTP header in the ContextData parameter.
This data type is a request parameter of server-side authentication operations like * AdminInitiateAuth and AdminRespondToAuthChallenge.
* @public */ export interface HttpHeader { /** *The header name.
* @public */ headerName?: string | undefined; /** *The header value.
* @public */ headerValue?: string | undefined; } /** *Contextual user data used for evaluating the risk of an authentication event by user * pool threat protection.
*This data type is a request parameter of server-side authentication operations like * AdminInitiateAuth and AdminRespondToAuthChallenge.
* @public */ export interface ContextDataType { /** *The source IP address of your user's device.
* @public */ IpAddress: string | undefined; /** *The name of your application's service endpoint.
* @public */ ServerName: string | undefined; /** *The path of your application's service endpoint.
* @public */ ServerPath: string | undefined; /** *The HTTP headers from your user's authentication request.
* @public */ HttpHeaders: HttpHeader[] | undefined; /** *Encoded device-fingerprint details that your app collected with the Amazon Cognito * context data collection library. For more information, see Adding user device and session data to API requests.
* @public */ EncodedData?: string | undefined; } /** *Initiates the authorization request, as an administrator.
* @public */ export interface AdminInitiateAuthRequest { /** *The ID of the Amazon Cognito user pool.
* @public */ UserPoolId: string | undefined; /** *The app client ID.
* @public */ ClientId: string | undefined; /** *The authentication flow that you want to initiate. The AuthParameters
* that you must submit are linked to the flow that you submit. For example:
* USER_AUTH: Request a preferred authentication type or review
* available authentication types. From the offered authentication types, select
* one in a challenge response and then authenticate with that method in an
* additional challenge response.
* REFRESH_TOKEN_AUTH: Receive new ID and access tokens when you
* pass a REFRESH_TOKEN parameter with a valid refresh token as the
* value.
* USER_SRP_AUTH: Receive secure remote password (SRP) variables for
* the next challenge, PASSWORD_VERIFIER, when you pass
* USERNAME and SRP_A parameters..
* ADMIN_USER_PASSWORD_AUTH: Receive new tokens or the next
* challenge, for example SOFTWARE_TOKEN_MFA, when you pass
* USERNAME and PASSWORD parameters.
Valid values include the following:
*The entry point for sign-in with passwords, one-time passwords, biometric * devices, and security keys.
*Username-password authentication with the Secure Remote Password (SRP) * protocol. For more information, see Use SRP password verification in custom * authentication flow.
*Provide a valid refresh token and receive new ID and access tokens. For * more information, see Using the refresh token.
*Custom authentication with Lambda triggers. For more information, see * Custom authentication challenge Lambda * triggers.
*Username-password authentication with the password sent directly in the * request. For more information, see Admin authentication flow.
*
* USER_PASSWORD_AUTH is a flow type of InitiateAuth and isn't valid for
* AdminInitiateAuth.
The authentication parameters. These are inputs corresponding to the
* AuthFlow that you're invoking. The required values depend on the value
* of AuthFlow:
For USER_AUTH: USERNAME (required),
* PREFERRED_CHALLENGE. If you don't provide a value for
* PREFERRED_CHALLENGE, Amazon Cognito responds with the
* AvailableChallenges parameter that specifies the available
* sign-in methods.
For USER_SRP_AUTH: USERNAME (required),
* SRP_A (required), SECRET_HASH (required if the app
* client is configured with a client secret), DEVICE_KEY.
For ADMIN_USER_PASSWORD_AUTH: USERNAME (required),
* PASSWORD (required), SECRET_HASH (required if the
* app client is configured with a client secret), DEVICE_KEY.
For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN
* (required), SECRET_HASH (required if the app client is configured
* with a client secret), DEVICE_KEY.
For CUSTOM_AUTH: USERNAME (required),
* SECRET_HASH (if app client is configured with client secret),
* DEVICE_KEY. To start the authentication flow with password
* verification, include ChallengeName: SRP_A and SRP_A: (The
* SRP_A Value).
For more information about SECRET_HASH, see Computing secret hash values. For information about
* DEVICE_KEY, see Working with user devices in your user pool.
A map of custom key-value pairs that you can provide as input for certain custom * workflows that this action triggers.
*You create custom workflows by assigning Lambda functions to user pool triggers. * When you use the AdminInitiateAuth API action, Amazon Cognito invokes the Lambda functions that * are specified for various triggers. The ClientMetadata value is passed as input to the * functions for only the following triggers:
*Pre signup
*Pre authentication
*User migration
*When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which
* the function receives as input. This payload contains a validationData
* attribute, which provides the data that you assigned to the ClientMetadata parameter in
* your AdminInitiateAuth request. In your function code in Lambda, you can process the
* validationData value to enhance your workflow for your specific
* needs.
When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the functions for * the following triggers, but it doesn't provide the ClientMetadata value as input:
*Post authentication
*Custom message
*Pre token generation
*Create auth challenge
*Define auth challenge
*Custom email sender
*Custom SMS sender
*For more information, see * Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
*When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the * following:
*Store the ClientMetadata value. This data is available only to Lambda * triggers that are assigned to a user pool to support custom workflows. If * your user pool configuration doesn't include triggers, the ClientMetadata * parameter serves no purpose.
*Validate the ClientMetadata value.
*Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive * information.
*The analytics metadata for collecting Amazon Pinpoint metrics for
* AdminInitiateAuth calls.
Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito * when it makes API requests.
* @public */ ContextData?: ContextDataType | undefined; /** *The optional session ID from a ConfirmSignUp API request. You can sign in
* a user directly from the sign-up process with the USER_AUTH authentication
* flow.
Information that your user pool responds with in AuthenticationResultwhen
* you configure it to remember devices and a user signs in with an unrecognized device.
* Amazon Cognito presents a new device key that you can use to set up device authentication in a "Remember me on this device"
* authentication model.
This data type is a response parameter of authentication operations like InitiateAuth, AdminInitiateAuth, RespondToAuthChallenge, and AdminRespondToAuthChallenge.
* @public */ export interface NewDeviceMetadataType { /** *The device key, an identifier used in generating the
* DEVICE_PASSWORD_VERIFIER for device SRP authentication.
The device group key, an identifier used in generating the
* DEVICE_PASSWORD_VERIFIER for device SRP authentication.
The object that your application receives after authentication. Contains tokens and * information for device authentication.
*This data type is a response parameter of authentication operations like InitiateAuth, AdminInitiateAuth, RespondToAuthChallenge, and AdminRespondToAuthChallenge.
* @public */ export interface AuthenticationResultType { /** *Your user's access token.
* @public */ AccessToken?: string | undefined; /** *The expiration period of the authentication result in seconds.
* @public */ ExpiresIn?: number | undefined; /** *The intended use of the token, for example Bearer.
Your user's refresh token.
* @public */ RefreshToken?: string | undefined; /** *Your user's ID token.
* @public */ IdToken?: string | undefined; /** *The new device metadata from an authentication result.
* @public */ NewDeviceMetadata?: NewDeviceMetadataType | undefined; } /** * @public * @enum */ export declare const ChallengeNameType: { readonly ADMIN_NO_SRP_AUTH: "ADMIN_NO_SRP_AUTH"; readonly CUSTOM_CHALLENGE: "CUSTOM_CHALLENGE"; readonly DEVICE_PASSWORD_VERIFIER: "DEVICE_PASSWORD_VERIFIER"; readonly DEVICE_SRP_AUTH: "DEVICE_SRP_AUTH"; readonly EMAIL_OTP: "EMAIL_OTP"; readonly MFA_SETUP: "MFA_SETUP"; readonly NEW_PASSWORD_REQUIRED: "NEW_PASSWORD_REQUIRED"; readonly PASSWORD: "PASSWORD"; readonly PASSWORD_SRP: "PASSWORD_SRP"; readonly PASSWORD_VERIFIER: "PASSWORD_VERIFIER"; readonly SELECT_CHALLENGE: "SELECT_CHALLENGE"; readonly SELECT_MFA_TYPE: "SELECT_MFA_TYPE"; readonly SMS_MFA: "SMS_MFA"; readonly SMS_OTP: "SMS_OTP"; readonly SOFTWARE_TOKEN_MFA: "SOFTWARE_TOKEN_MFA"; readonly WEB_AUTHN: "WEB_AUTHN"; }; /** * @public */ export type ChallengeNameType = (typeof ChallengeNameType)[keyof typeof ChallengeNameType]; /** *Initiates the authentication response, as an administrator.
* @public */ export interface AdminInitiateAuthResponse { /** *The name of the challenge that you're responding to with this call. This is returned
* in the AdminInitiateAuth response if you must pass another
* challenge.
* WEB_AUTHN: Respond to the challenge with the results of a
* successful authentication with a passkey, or webauthN, factor. These are
* typically biometric devices or security keys.
* PASSWORD: Respond with USER_PASSWORD_AUTH
* parameters: USERNAME (required), PASSWORD (required),
* SECRET_HASH (required if the app client is configured with a
* client secret), DEVICE_KEY.
* PASSWORD_SRP: Respond with USER_SRP_AUTH parameters:
* USERNAME (required), SRP_A (required),
* SECRET_HASH (required if the app client is configured with a
* client secret), DEVICE_KEY.
* SELECT_CHALLENGE: Respond to the challenge with
* USERNAME and an ANSWER that matches one of the
* challenge types in the AvailableChallenges response
* parameter.
* MFA_SETUP: If MFA is required, users who don't have at least one
* of the MFA methods set up are presented with an MFA_SETUP
* challenge. The user must set up at least one MFA type to continue to
* authenticate.
* SELECT_MFA_TYPE: Selects the MFA type. Valid MFA options are
* SMS_MFA for SMS message MFA, EMAIL_OTP for email
* message MFA, and SOFTWARE_TOKEN_MFA for time-based one-time
* password (TOTP) software token MFA.
* SMS_MFA: Next challenge is to supply an
* SMS_MFA_CODEthat your user pool delivered in an SMS message.
* EMAIL_OTP: Next challenge is to supply an
* EMAIL_OTP_CODE that your user pool delivered in an email
* message.
* PASSWORD_VERIFIER: Next challenge is to supply
* PASSWORD_CLAIM_SIGNATURE,
* PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after
* the client-side SRP calculations.
* CUSTOM_CHALLENGE: This is returned if your custom authentication
* flow determines that the user should pass another challenge before tokens are
* issued.
* DEVICE_SRP_AUTH: If device tracking was activated in your user
* pool and the previous challenges were passed, this challenge is returned so that
* Amazon Cognito can start tracking this device.
* DEVICE_PASSWORD_VERIFIER: Similar to
* PASSWORD_VERIFIER, but for devices only.
* ADMIN_NO_SRP_AUTH: This is returned if you must authenticate with
* USERNAME and PASSWORD directly. An app client must
* be enabled to use this flow.
* NEW_PASSWORD_REQUIRED: For users who are required to change their
* passwords after successful first login. Respond to this challenge with
* NEW_PASSWORD and any required attributes that Amazon Cognito returned in
* the requiredAttributes parameter. You can also set values for
* attributes that aren't required by your user pool and that your app client can
* write. For more information, see AdminRespondToAuthChallenge.
Amazon Cognito only returns this challenge for users who have temporary passwords.
* Because of this, and because in some cases you can create users who don't have
* values for required attributes, take care to collect and submit
* required-attribute values for all users who don't have passwords. You can create
* a user in the Amazon Cognito console without, for example, a required
* birthdate attribute. The API response from Amazon Cognito won't prompt
* you to submit a birthdate for the user if they don't have a password.
In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value.
* In AdminRespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter,
* then use the AdminUpdateUserAttributes API operation to modify the value of any additional attributes.
* MFA_SETUP: For users who are required to set up an MFA factor
* before they can sign in. The MFA types activated for the user pool will be
* listed in the challenge parameters MFAS_CAN_SETUP value.
To set up software token MFA, use the session returned here from
* InitiateAuth as an input to
* AssociateSoftwareToken, and use the session returned by
* VerifySoftwareToken as an input to
* RespondToAuthChallenge with challenge name
* MFA_SETUP to complete sign-in. To set up SMS MFA, users will
* need help from an administrator to add a phone number to their account and then
* call InitiateAuth again to restart sign-in.
The session that should be passed both ways in challenge-response calls to the
* service. If AdminInitiateAuth or AdminRespondToAuthChallenge
* API call determines that the caller must pass another challenge, they return a session
* with other challenge parameters. This session should be passed as it is to the next
* AdminRespondToAuthChallenge API call.
The challenge parameters. These are returned to you in the
* AdminInitiateAuth response if you must pass another challenge. The
* responses in this parameter should be used to compute inputs to the next call
* (AdminRespondToAuthChallenge).
All challenges require USERNAME and SECRET_HASH (if
* applicable).
The value of the USER_ID_FOR_SRP attribute is the user's actual username,
* not an alias (such as email address or phone number), even if you specified an alias in
* your call to AdminInitiateAuth. This happens because, in the
* AdminRespondToAuthChallenge API ChallengeResponses, the
* USERNAME attribute can't be an alias.
The result of the authentication response. This is only returned if the caller doesn't
* need to pass another challenge. If the caller does need to pass another challenge before
* it gets tokens, ChallengeName, ChallengeParameters, and
* Session are returned.
This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP * status code: 400.
* @public */ export declare class InvalidEmailRoleAccessPolicyException extends __BaseException { readonly name: "InvalidEmailRoleAccessPolicyException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThis exception is thrown when Amazon Cognito can't find a multi-factor authentication * (MFA) method.
* @public */ export declare class MFAMethodNotFoundException extends __BaseException { readonly name: "MFAMethodNotFoundException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThis exception is thrown when a password reset is required.
* @public */ export declare class PasswordResetRequiredException extends __BaseException { readonly name: "PasswordResetRequiredException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThis exception is thrown when a user isn't confirmed successfully.
* @public */ export declare class UserNotConfirmedException extends __BaseException { readonly name: "UserNotConfirmedException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe user pool ID for the user pool.
* @public */ UserPoolId: string | undefined; /** *The existing user in the user pool that you want to assign to the external IdP user * account. This user can be a local (Username + Password) Amazon Cognito user pools user or a * federated user (for example, a SAML or Facebook user). If the user doesn't exist, Amazon Cognito * generates an exception. Amazon Cognito returns this user when the new user (with the linked IdP * attribute) signs in.
*For a native username + password user, the ProviderAttributeValue for the
* DestinationUser should be the username in the user pool. For a
* federated user, it should be the provider-specific user_id.
The ProviderAttributeName of the DestinationUser is
* ignored.
The ProviderName should be set to Cognito for users in
* Cognito user pools.
All attributes in the DestinationUser profile must be mutable. If you have * assigned the user any immutable custom attributes, the operation won't * succeed.
*An external IdP account for a user who doesn't exist yet in the user pool. This user * must be a federated user (for example, a SAML or Facebook user), not another native * user.
*If the SourceUser is using a federated social IdP, such as Facebook,
* Google, or Login with Amazon, you must set the ProviderAttributeName to
* Cognito_Subject. For social IdPs, the ProviderName will be
* Facebook, Google, or LoginWithAmazon, and
* Amazon Cognito will automatically parse the Facebook, Google, and Login with Amazon tokens for
* id, sub, and user_id, respectively. The
* ProviderAttributeValue for the user must be the same value as the
* id, sub, or user_id value found in the social
* IdP token.
For OIDC, the ProviderAttributeName can be any mapped value from a claim
* in the ID token, or that your app retrieves from the userInfo endpoint. For
* SAML, the ProviderAttributeName can be any mapped value from a claim in the
* SAML assertion.
The following additional considerations apply to SourceUser for OIDC and
* SAML providers.
You must map the claim to a user pool attribute in your IdP configuration, and
* set the user pool attribute name as the value of
* ProviderAttributeName in your
* AdminLinkProviderForUser request. For example,
* email.
When you set ProviderAttributeName to
* Cognito_Subject, Amazon Cognito will automatically parse the default
* unique identifier found in the subject from the IdP token.
Represents the request to list devices, as an administrator.
* @public */ export interface AdminListDevicesRequest { /** *The user pool ID.
* @public */ UserPoolId: string | undefined; /** *The username of the user that you want to query or modify. The value of this parameter
* is typically your user's username, but it can be any of their alias attributes. If
* username isn't an alias attribute in your user pool, this value
* must be the sub of a local user or the username of a user from a
* third-party IdP.
The limit of the devices request.
* @public */ Limit?: number | undefined; /** *This API operation returns a limited number of results. The pagination token is * an identifier that you can present in an additional API request with the same parameters. When * you include the pagination token, Amazon Cognito returns the next set of items after the current list. * Subsequent requests return a new pagination token. By use of this token, you can paginate * through the full list of items.
* @public */ PaginationToken?: string | undefined; } /** *Lists the device's response, as an administrator.
* @public */ export interface AdminListDevicesResponse { /** *The devices in the list of devices response.
* @public */ Devices?: DeviceType[] | undefined; /** *The identifier that Amazon Cognito returned with the previous request to this operation. When * you include a pagination token in your request, Amazon Cognito returns the next set of items in * the list. By use of this token, you can paginate through the full list of items.
* @public */ PaginationToken?: string | undefined; } /** * @public */ export interface AdminListGroupsForUserRequest { /** *The username of the user that you want to query or modify. The value of this parameter
* is typically your user's username, but it can be any of their alias attributes. If
* username isn't an alias attribute in your user pool, this value
* must be the sub of a local user or the username of a user from a
* third-party IdP.
The user pool ID for the user pool.
* @public */ UserPoolId: string | undefined; /** *The limit of the request to list groups.
* @public */ Limit?: number | undefined; /** *An identifier that was returned from the previous call to this operation, which can be * used to return the next set of items in the list.
* @public */ NextToken?: string | undefined; } /** *A user pool group. Contains details about the group and the way that it contributes to * IAM role decisions with identity pools. Identity pools can make decisions about the * IAM role to assign based on groups: users get credentials for the role associated with * their highest-priority group.
*This data type is a response parameter of AdminListGroupsForUser, CreateGroup, GetGroup, ListGroups, and UpdateGroup.
* @public */ export interface GroupType { /** *The name of the group.
* @public */ GroupName?: string | undefined; /** *The ID of the user pool that contains the group.
* @public */ UserPoolId?: string | undefined; /** *A friendly description of the group.
* @public */ Description?: string | undefined; /** *The ARN of the IAM role associated with the group. If a group has the highest
* priority of a user's groups, users who authenticate with an identity pool get
* credentials for the RoleArn that's associated with the group.
A non-negative integer value that specifies the precedence of this group relative to
* the other groups that a user can belong to in the user pool. Zero is the highest
* precedence value. Groups with lower Precedence values take precedence over
* groups with higher ornull Precedence values. If a user belongs to two or
* more groups, it is the group with the lowest precedence value whose role ARN is given in
* the user's tokens for the cognito:roles and
* cognito:preferred_role claims.
Two groups can have the same Precedence value. If this happens, neither
* group takes precedence over the other. If two groups with the same
* Precedence have the same role ARN, that role is used in the
* cognito:preferred_role claim in tokens for users in each group. If the
* two groups have different role ARNs, the cognito:preferred_role claim isn't
* set in users' tokens.
The default Precedence value is null.
The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
* human-readable format like ISO 8601 or a Java Date object.
The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
* human-readable format like ISO 8601 or a Java Date object.
The groups that the user belongs to.
* @public */ Groups?: GroupType[] | undefined; /** *An identifier that was returned from the previous call to this operation, which can be * used to return the next set of items in the list.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface AdminListUserAuthEventsRequest { /** *The user pool ID.
* @public */ UserPoolId: string | undefined; /** *The username of the user that you want to query or modify. The value of this parameter
* is typically your user's username, but it can be any of their alias attributes. If
* username isn't an alias attribute in your user pool, this value
* must be the sub of a local user or the username of a user from a
* third-party IdP.
The maximum number of authentication events to return. Returns 60 events if you set
* MaxResults to 0, or if you don't include a MaxResults
* parameter.
A pagination token.
* @public */ NextToken?: string | undefined; } /** * @public * @enum */ export declare const ChallengeName: { readonly Mfa: "Mfa"; readonly Password: "Password"; }; /** * @public */ export type ChallengeName = (typeof ChallengeName)[keyof typeof ChallengeName]; /** * @public * @enum */ export declare const ChallengeResponse: { readonly Failure: "Failure"; readonly Success: "Success"; }; /** * @public */ export type ChallengeResponse = (typeof ChallengeResponse)[keyof typeof ChallengeResponse]; /** *The responses to the challenge that you received in the previous request. Each * challenge has its own required response parameters. The following examples are partial * JSON request bodies that highlight challenge-response parameters.
*You must provide a SECRET_HASH parameter in all challenge responses to an app
* client that has a client secret. Include a DEVICE_KEY for device
* authentication.
* "ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": \{
* "USERNAME": "[username]",
* "ANSWER": "[Challenge name]"\}
*
Available challenges are PASSWORD, PASSWORD_SRP,
* EMAIL_OTP, SMS_OTP, and WEB_AUTHN.
Complete authentication in the SELECT_CHALLENGE response for
* PASSWORD, PASSWORD_SRP, and WEB_AUTHN:
* "ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": \{
* "ANSWER": "WEB_AUTHN",
* "USERNAME": "[username]",
* "CREDENTIAL": "[AuthenticationResponseJSON]"\}
*
* "ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": \{
* "ANSWER": "PASSWORD",
* "USERNAME": "[username]",
* "PASSWORD": "[password]"\}
*
* "ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": \{
* "ANSWER": "PASSWORD_SRP",
* "USERNAME": "[username]",
* "SRP_A": "[SRP_A]"\}
*
For SMS_OTP and EMAIL_OTP, respond with the
* username and answer. Your user pool will send a code for the user to submit in
* the next challenge response.
* "ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": \{
* "ANSWER": "SMS_OTP",
* "USERNAME": "[username]"\}
*
* "ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": \{
* "ANSWER": "EMAIL_OTP",
* "USERNAME": "[username]"\}
*
* "ChallengeName": "SMS_OTP", "ChallengeResponses":
* \{"SMS_OTP_CODE": "[code]", "USERNAME": "[username]"\}
*
* "ChallengeName": "EMAIL_OTP", "ChallengeResponses": \{"EMAIL_OTP_CODE":
* "[code]", "USERNAME": "[username]"\}
*
* "ChallengeName": "SMS_MFA", "ChallengeResponses": \{"SMS_MFA_CODE":
* "[code]", "USERNAME": "[username]"\}
*
This challenge response is part of the SRP flow. Amazon Cognito requires
* that your application respond to this challenge within a few seconds. When
* the response time exceeds this period, your user pool returns a
* NotAuthorizedException error.
* "ChallengeName": "PASSWORD_VERIFIER", "ChallengeResponses":
* \{"PASSWORD_CLAIM_SIGNATURE": "[claim_signature]",
* "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP":
* [timestamp], "USERNAME": "[username]"\}
*
Add "DEVICE_KEY" when you sign in with a remembered
* device.
* "ChallengeName": "CUSTOM_CHALLENGE", "ChallengeResponses":
* \{"USERNAME": "[username]", "ANSWER": "[challenge_answer]"\}
*
Add "DEVICE_KEY" when you sign in with a remembered
* device.
* "ChallengeName": "NEW_PASSWORD_REQUIRED", "ChallengeResponses":
* \{"NEW_PASSWORD": "[new_password]", "USERNAME":
* "[username]"\}
*
To set any required attributes that InitiateAuth returned in
* an requiredAttributes parameter, add
* "userAttributes.[attribute_name]": "[attribute_value]".
* This parameter can also set values for writable attributes that aren't
* required by your user pool.
In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value.
* In RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter,
* then use the UpdateUserAttributes API operation to modify the value of any additional attributes.
* "ChallengeName": "SOFTWARE_TOKEN_MFA", "ChallengeResponses":
* \{"USERNAME": "[username]", "SOFTWARE_TOKEN_MFA_CODE":
* [authenticator_code]\}
*
* "ChallengeName": "DEVICE_SRP_AUTH", "ChallengeResponses": \{"USERNAME":
* "[username]", "DEVICE_KEY": "[device_key]", "SRP_A":
* "[srp_a]"\}
*
* "ChallengeName": "DEVICE_PASSWORD_VERIFIER", "ChallengeResponses":
* \{"DEVICE_KEY": "[device_key]", "PASSWORD_CLAIM_SIGNATURE":
* "[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]",
* "TIMESTAMP": [timestamp], "USERNAME": "[username]"\}
*
* "ChallengeName": "MFA_SETUP", "ChallengeResponses": \{"USERNAME":
* "[username]"\}, "SESSION": "[Session ID from
* VerifySoftwareToken]"
*
* "ChallengeName": "SELECT_MFA_TYPE", "ChallengeResponses": \{"USERNAME":
* "[username]", "ANSWER": "[SMS_MFA or SOFTWARE_TOKEN_MFA]"\}
*
For more information about SECRET_HASH, see Computing secret hash values. For information about
* DEVICE_KEY, see Working with user devices in your user pool.
This data type is a request parameter of RespondToAuthChallenge and AdminRespondToAuthChallenge.
* @public */ export interface ChallengeResponseType { /** *The type of challenge that your previous authentication request returned in the
* parameter ChallengeName, for example SMS_MFA.
The set of key-value pairs that provides a response to the requested challenge.
* @public */ ChallengeResponse?: ChallengeResponse | undefined; } /** *The context data that your application submitted in an authentication request with * advanced security features, as displayed in an AdminListUserAuthEvents response.
* @public */ export interface EventContextDataType { /** *The source IP address of your user's device.
* @public */ IpAddress?: string | undefined; /** *The user's device name.
* @public */ DeviceName?: string | undefined; /** *The user's time zone.
* @public */ Timezone?: string | undefined; /** *The user's city.
* @public */ City?: string | undefined; /** *The user's country.
* @public */ Country?: string | undefined; } /** * @public * @enum */ export declare const FeedbackValueType: { readonly INVALID: "Invalid"; readonly VALID: "Valid"; }; /** * @public */ export type FeedbackValueType = (typeof FeedbackValueType)[keyof typeof FeedbackValueType]; /** *The feedback that your application submitted to an advanced security features event * log, as displayed in an AdminListUserAuthEvents response.
* @public */ export interface EventFeedbackType { /** *The authentication event feedback value. When you provide a FeedbackValue
* value of valid, you tell Amazon Cognito that you trust a user session where Amazon Cognito
* has evaluated some level of risk. When you provide a FeedbackValue value of
* invalid, you tell Amazon Cognito that you don't trust a user session, or you
* don't believe that Amazon Cognito evaluated a high-enough risk level.
The submitter of the event feedback. For example, if you submit event feedback in the
* Amazon Cognito console, this value is Admin.
The date that you or your user submitted the feedback.
* @public */ FeedbackDate?: Date | undefined; } /** * @public * @enum */ export declare const EventResponseType: { readonly Fail: "Fail"; readonly InProgress: "InProgress"; readonly Pass: "Pass"; }; /** * @public */ export type EventResponseType = (typeof EventResponseType)[keyof typeof EventResponseType]; /** * @public * @enum */ export declare const RiskDecisionType: { readonly AccountTakeover: "AccountTakeover"; readonly Block: "Block"; readonly NoRisk: "NoRisk"; }; /** * @public */ export type RiskDecisionType = (typeof RiskDecisionType)[keyof typeof RiskDecisionType]; /** * @public * @enum */ export declare const RiskLevelType: { readonly High: "High"; readonly Low: "Low"; readonly Medium: "Medium"; }; /** * @public */ export type RiskLevelType = (typeof RiskLevelType)[keyof typeof RiskLevelType]; /** *The risk evaluation by adaptive authentication, as displayed in an AdminListUserAuthEvents response. Contains evaluations * of compromised-credentials detection and assessed risk level and action taken by * adaptive authentication.
* @public */ export interface EventRiskType { /** *The action taken by adaptive authentication. If NoRisk, your user pool
* took no action. If AccountTakeover, your user pool applied the adaptive
* authentication automated response that you configured. If Block, your user
* pool prevented the attempt.
The risk level that adaptive authentication assessed for the authentication * event.
* @public */ RiskLevel?: RiskLevelType | undefined; /** *Indicates whether compromised credentials were detected during an authentication * event.
* @public */ CompromisedCredentialsDetected?: boolean | undefined; } /** * @public * @enum */ export declare const EventType: { readonly ForgotPassword: "ForgotPassword"; readonly PasswordChange: "PasswordChange"; readonly ResendCode: "ResendCode"; readonly SignIn: "SignIn"; readonly SignUp: "SignUp"; }; /** * @public */ export type EventType = (typeof EventType)[keyof typeof EventType]; /** *One authentication event that Amazon Cognito logged in a user pool with advanced security * features active. Contains user and device metadata and a risk assessment from your user * pool.
*This data type is a request parameter of AdminListUserAuthEvents.
* @public */ export interface AuthEventType { /** *The event ID.
* @public */ EventId?: string | undefined; /** *The type of authentication event.
* @public */ EventType?: EventType | undefined; /** *The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
* human-readable format like ISO 8601 or a Java Date object.
The event response.
* @public */ EventResponse?: EventResponseType | undefined; /** *The threat evaluation from your user pool about an event. Contains information about * whether your user pool detected compromised credentials, whether the event triggered an * automated response, and the level of risk.
* @public */ EventRisk?: EventRiskType | undefined; /** *A list of the challenges that the user was requested to answer, for example
* Password, and the result, for example Success.
The user context data captured at the time of an event request. This value provides * additional information about the client from which event the request is received.
* @public */ EventContextData?: EventContextDataType | undefined; /** *The UpdateAuthEventFeedback or AdminUpdateAuthEventFeedback feedback that you or your
* user provided in response to the event. A value of Valid indicates that you
* disagreed with the level of risk that your user pool assigned, and evaluated a session
* to be valid, or likely safe. A value of Invalid indicates that you agreed
* with the user pool risk level and evaluated a session to be invalid, or likely
* malicious.
The response object. It includes the EventID, EventType,
* CreationDate, EventRisk, and
* EventResponse.
A pagination token.
* @public */ NextToken?: string | undefined; } /** *This exception is thrown when user pool add-ons aren't enabled.
* @public */ export declare class UserPoolAddOnNotEnabledException extends __BaseException { readonly name: "UserPoolAddOnNotEnabledException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe user pool ID for the user pool.
* @public */ UserPoolId: string | undefined; /** *The username of the user that you want to query or modify. The value of this parameter
* is typically your user's username, but it can be any of their alias attributes. If
* username isn't an alias attribute in your user pool, this value
* must be the sub of a local user or the username of a user from a
* third-party IdP.
The group name.
* @public */ GroupName: string | undefined; } /** *Represents the request to reset a user's password as an administrator.
* @public */ export interface AdminResetUserPasswordRequest { /** *The user pool ID for the user pool where you want to reset the user's password.
* @public */ UserPoolId: string | undefined; /** *The username of the user that you want to query or modify. The value of this parameter
* is typically your user's username, but it can be any of their alias attributes. If
* username isn't an alias attribute in your user pool, this value
* must be the sub of a local user or the username of a user from a
* third-party IdP.
A map of custom key-value pairs that you can provide as input for any custom workflows * that this action triggers.
*You create custom workflows by assigning Lambda functions to user pool
* triggers. When you use the AdminResetUserPassword API action, Amazon Cognito invokes the function
* that is assigned to the custom message trigger. When Amazon Cognito invokes
* this function, it passes a JSON payload, which the function receives as input. This
* payload contains a clientMetadata attribute, which provides the data that
* you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In
* your function code in Lambda, you can process the
* clientMetadata value to enhance your workflow for your specific needs.
For more information, see * Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
*When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the * following:
*Store the ClientMetadata value. This data is available only to Lambda * triggers that are assigned to a user pool to support custom workflows. If * your user pool configuration doesn't include triggers, the ClientMetadata * parameter serves no purpose.
*Validate the ClientMetadata value.
*Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive * information.
*Represents the response from the server to reset a user password as an * administrator.
* @public */ export interface AdminResetUserPasswordResponse { } /** *The request to respond to the authentication challenge, as an administrator.
* @public */ export interface AdminRespondToAuthChallengeRequest { /** *The ID of the Amazon Cognito user pool.
* @public */ UserPoolId: string | undefined; /** *The app client ID.
* @public */ ClientId: string | undefined; /** *The challenge name. For more information, see AdminInitiateAuth.
* @public */ ChallengeName: ChallengeNameType | undefined; /** *The responses to the challenge that you received in the previous request. Each * challenge has its own required response parameters. The following examples are partial * JSON request bodies that highlight challenge-response parameters.
*You must provide a SECRET_HASH parameter in all challenge responses to an app
* client that has a client secret. Include a DEVICE_KEY for device
* authentication.
* "ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": \{
* "USERNAME": "[username]",
* "ANSWER": "[Challenge name]"\}
*
Available challenges are PASSWORD, PASSWORD_SRP,
* EMAIL_OTP, SMS_OTP, and WEB_AUTHN.
Complete authentication in the SELECT_CHALLENGE response for
* PASSWORD, PASSWORD_SRP, and WEB_AUTHN:
* "ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": \{
* "ANSWER": "WEB_AUTHN",
* "USERNAME": "[username]",
* "CREDENTIAL": "[AuthenticationResponseJSON]"\}
*
* "ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": \{
* "ANSWER": "PASSWORD",
* "USERNAME": "[username]",
* "PASSWORD": "[password]"\}
*
* "ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": \{
* "ANSWER": "PASSWORD_SRP",
* "USERNAME": "[username]",
* "SRP_A": "[SRP_A]"\}
*
For SMS_OTP and EMAIL_OTP, respond with the
* username and answer. Your user pool will send a code for the user to submit in
* the next challenge response.
* "ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": \{
* "ANSWER": "SMS_OTP",
* "USERNAME": "[username]"\}
*
* "ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": \{
* "ANSWER": "EMAIL_OTP",
* "USERNAME": "[username]"\}
*
* "ChallengeName": "SMS_OTP", "ChallengeResponses":
* \{"SMS_OTP_CODE": "[code]", "USERNAME": "[username]"\}
*
* "ChallengeName": "EMAIL_OTP", "ChallengeResponses": \{"EMAIL_OTP_CODE":
* "[code]", "USERNAME": "[username]"\}
*
* "ChallengeName": "SMS_MFA", "ChallengeResponses": \{"SMS_MFA_CODE":
* "[code]", "USERNAME": "[username]"\}
*
This challenge response is part of the SRP flow. Amazon Cognito requires
* that your application respond to this challenge within a few seconds. When
* the response time exceeds this period, your user pool returns a
* NotAuthorizedException error.
* "ChallengeName": "PASSWORD_VERIFIER", "ChallengeResponses":
* \{"PASSWORD_CLAIM_SIGNATURE": "[claim_signature]",
* "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP":
* [timestamp], "USERNAME": "[username]"\}
*
Add "DEVICE_KEY" when you sign in with a remembered
* device.
* "ChallengeName": "CUSTOM_CHALLENGE", "ChallengeResponses":
* \{"USERNAME": "[username]", "ANSWER": "[challenge_answer]"\}
*
Add "DEVICE_KEY" when you sign in with a remembered
* device.
* "ChallengeName": "NEW_PASSWORD_REQUIRED", "ChallengeResponses":
* \{"NEW_PASSWORD": "[new_password]", "USERNAME":
* "[username]"\}
*
To set any required attributes that InitiateAuth returned in
* an requiredAttributes parameter, add
* "userAttributes.[attribute_name]": "[attribute_value]".
* This parameter can also set values for writable attributes that aren't
* required by your user pool.
In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value.
* In RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter,
* then use the UpdateUserAttributes API operation to modify the value of any additional attributes.
* "ChallengeName": "SOFTWARE_TOKEN_MFA", "ChallengeResponses":
* \{"USERNAME": "[username]", "SOFTWARE_TOKEN_MFA_CODE":
* [authenticator_code]\}
*
* "ChallengeName": "DEVICE_SRP_AUTH", "ChallengeResponses": \{"USERNAME":
* "[username]", "DEVICE_KEY": "[device_key]", "SRP_A":
* "[srp_a]"\}
*
* "ChallengeName": "DEVICE_PASSWORD_VERIFIER", "ChallengeResponses":
* \{"DEVICE_KEY": "[device_key]", "PASSWORD_CLAIM_SIGNATURE":
* "[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]",
* "TIMESTAMP": [timestamp], "USERNAME": "[username]"\}
*
* "ChallengeName": "MFA_SETUP", "ChallengeResponses": \{"USERNAME":
* "[username]"\}, "SESSION": "[Session ID from
* VerifySoftwareToken]"
*
* "ChallengeName": "SELECT_MFA_TYPE", "ChallengeResponses": \{"USERNAME":
* "[username]", "ANSWER": "[SMS_MFA or SOFTWARE_TOKEN_MFA]"\}
*
For more information about SECRET_HASH, see Computing secret hash values. For information about
* DEVICE_KEY, see Working with user devices in your user pool.
The session that should be passed both ways in challenge-response calls to the
* service. If an InitiateAuth or RespondToAuthChallenge API call
* determines that the caller must pass another challenge, it returns a session with other
* challenge parameters. This session should be passed as it is to the next
* RespondToAuthChallenge API call.
The analytics metadata for collecting Amazon Pinpoint metrics for
* AdminRespondToAuthChallenge calls.
Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito * when it makes API requests.
* @public */ ContextData?: ContextDataType | undefined; /** *A map of custom key-value pairs that you can provide as input for any custom workflows * that this action triggers.
*You create custom workflows by assigning Lambda functions to user pool triggers. * When you use the AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions * that you have assigned to the following triggers:
*pre sign-up
*custom message
*post authentication
*user migration
*pre token generation
*define auth challenge
*create auth challenge
*verify auth challenge response
*When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the
* function receives as input. This payload contains a clientMetadata
* attribute that provides the data that you assigned to the ClientMetadata parameter in
* your AdminRespondToAuthChallenge request. In your function code in Lambda, you can
* process the clientMetadata value to enhance your workflow for your specific
* needs.
For more information, see * Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
*When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the * following:
*Store the ClientMetadata value. This data is available only to Lambda * triggers that are assigned to a user pool to support custom workflows. If * your user pool configuration doesn't include triggers, the ClientMetadata * parameter serves no purpose.
*Validate the ClientMetadata value.
*Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive * information.
*Responds to the authentication challenge, as an administrator.
* @public */ export interface AdminRespondToAuthChallengeResponse { /** *The name of the challenge. For more information, see AdminInitiateAuth.
* @public */ ChallengeName?: ChallengeNameType | undefined; /** *The session that should be passed both ways in challenge-response calls to the
* service. If the caller must pass another challenge, they return a session with other
* challenge parameters. This session should be passed as it is to the next
* RespondToAuthChallenge API call.
The challenge parameters. For more information, see AdminInitiateAuth.
* @public */ ChallengeParameters?: RecordThe result returned by the server in response to the authentication request.
* @public */ AuthenticationResult?: AuthenticationResultType | undefined; } /** *This exception is thrown if the provided code doesn't match what the server was * expecting.
* @public */ export declare class CodeMismatchException extends __BaseException { readonly name: "CodeMismatchException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThis exception is thrown if a code has expired.
* @public */ export declare class ExpiredCodeException extends __BaseException { readonly name: "ExpiredCodeException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe message returned when a user's new password matches a previous password and * doesn't comply with the password-history policy.
* @public */ export declare class PasswordHistoryPolicyViolationException extends __BaseException { readonly name: "PasswordHistoryPolicyViolationException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThis exception is thrown when the software token time-based one-time password (TOTP) * multi-factor authentication (MFA) isn't activated for the user pool.
* @public */ export declare class SoftwareTokenMFANotFoundException extends __BaseException { readonly name: "SoftwareTokenMFANotFoundException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeUser preferences for multi-factor authentication with email messages. Activates or * deactivates email MFA and sets it as the preferred MFA method when multiple methods are * available. To activate this setting, * advanced security features must be active in your user pool.
*This data type is a request parameter of SetUserMFAPreference and AdminSetUserMFAPreference.
* @public */ export interface EmailMfaSettingsType { /** *Specifies whether email message MFA is active for a user. When the value of this
* parameter is Enabled, the user will be prompted for MFA during all sign-in
* attempts, unless device tracking is turned on and the device has been trusted.
Specifies whether email message MFA is the user's preferred method.
* @public */ PreferredMfa?: boolean | undefined; } /** *A user's preference for using SMS message multi-factor authentication (MFA). Turns SMS * MFA on and off, and can set SMS as preferred when other MFA options are available. You * can't turn off SMS MFA for any of your users when MFA is required in your user pool; you * can only set the type that your user prefers.
*This data type is a request parameter of SetUserMFAPreference and AdminSetUserMFAPreference.
* @public */ export interface SMSMfaSettingsType { /** *Specifies whether SMS message MFA is activated. 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.
* @public */ Enabled?: boolean | undefined; /** *Specifies whether SMS is the preferred MFA method. If true, your user pool prompts the * specified user for a code delivered by SMS message after username-password sign-in * succeeds.
* @public */ PreferredMfa?: boolean | undefined; } /** *A user's preference for using time-based one-time password (TOTP) multi-factor * authentication (MFA). Turns TOTP MFA on and off, and can set TOTP as preferred when * other MFA options are available. You can't turn off TOTP MFA for any of your users when * MFA is required in your user pool; you can only set the type that your user prefers.
*This data type is a request parameter of SetUserMFAPreference and AdminSetUserMFAPreference.
* @public */ export interface SoftwareTokenMfaSettingsType { /** *Specifies whether software token MFA is activated. 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.
* @public */ Enabled?: boolean | undefined; /** *Specifies whether software token MFA is the preferred MFA method.
* @public */ PreferredMfa?: boolean | undefined; } /** * @public */ export interface AdminSetUserMFAPreferenceRequest { /** *User preferences for SMS message MFA. Activates or deactivates SMS MFA and sets it as * the preferred MFA method when multiple methods are available.
* @public */ SMSMfaSettings?: SMSMfaSettingsType | undefined; /** *User preferences for time-based one-time password (TOTP) MFA. Activates or deactivates * TOTP MFA and sets it as the preferred MFA method when multiple methods are * available.
* @public */ SoftwareTokenMfaSettings?: SoftwareTokenMfaSettingsType | undefined; /** *User preferences for email message MFA. Activates or deactivates email MFA and sets it * as the preferred MFA method when multiple methods are available. To activate this setting, * advanced security features must be active in your user pool.
* @public */ EmailMfaSettings?: EmailMfaSettingsType | undefined; /** *The username of the user that you want to query or modify. The value of this parameter
* is typically your user's username, but it can be any of their alias attributes. If
* username isn't an alias attribute in your user pool, this value
* must be the sub of a local user or the username of a user from a
* third-party IdP.
The ID of the user pool where you want to set a user's MFA preferences.
* @public */ UserPoolId: string | undefined; } /** * @public */ export interface AdminSetUserMFAPreferenceResponse { } /** * @public */ export interface AdminSetUserPasswordRequest { /** *The user pool ID for the user pool where you want to set the user's password.
* @public */ UserPoolId: string | undefined; /** *The username of the user that you want to query or modify. The value of this parameter
* is typically your user's username, but it can be any of their alias attributes. If
* username isn't an alias attribute in your user pool, this value
* must be the sub of a local user or the username of a user from a
* third-party IdP.
The password for the user.
* @public */ Password: string | undefined; /** *
* True if the password is permanent, False if it is
* temporary.
You can use this parameter to set an MFA configuration that uses the SMS delivery * medium.
* @public */ export interface AdminSetUserSettingsRequest { /** *The ID of the user pool that contains the user whose options you're setting.
* @public */ UserPoolId: string | undefined; /** *The username of the user that you want to query or modify. The value of this parameter
* is typically your user's username, but it can be any of their alias attributes. If
* username isn't an alias attribute in your user pool, this value
* must be the sub of a local user or the username of a user from a
* third-party IdP.
You can use this parameter only to set an SMS configuration that uses SMS for * delivery.
* @public */ MFAOptions: MFAOptionType[] | undefined; } /** *Represents the response from the server to set user settings as an * administrator.
* @public */ export interface AdminSetUserSettingsResponse { } /** * @public */ export interface AdminUpdateAuthEventFeedbackRequest { /** *The user pool ID.
* @public */ UserPoolId: string | undefined; /** *The username of the user that you want to query or modify. The value of this parameter
* is typically your user's username, but it can be any of their alias attributes. If
* username isn't an alias attribute in your user pool, this value
* must be the sub of a local user or the username of a user from a
* third-party IdP.
The authentication event ID.
* @public */ EventId: string | undefined; /** *The authentication event feedback value. When you provide a FeedbackValue
* value of valid, you tell Amazon Cognito that you trust a user session where Amazon Cognito
* has evaluated some level of risk. When you provide a FeedbackValue value of
* invalid, you tell Amazon Cognito that you don't trust a user session, or you
* don't believe that Amazon Cognito evaluated a high-enough risk level.
The request to update the device status, as an administrator.
* @public */ export interface AdminUpdateDeviceStatusRequest { /** *The user pool ID.
* @public */ UserPoolId: string | undefined; /** *The username of the user that you want to query or modify. The value of this parameter
* is typically your user's username, but it can be any of their alias attributes. If
* username isn't an alias attribute in your user pool, this value
* must be the sub of a local user or the username of a user from a
* third-party IdP.
The device key.
* @public */ DeviceKey: string | undefined; /** *The status indicating whether a device has been remembered or not.
* @public */ DeviceRememberedStatus?: DeviceRememberedStatusType | undefined; } /** *The status response to the request to update the device, as an administrator.
* @public */ export interface AdminUpdateDeviceStatusResponse { } /** *Represents the request to update the user's attributes as an administrator.
* @public */ export interface AdminUpdateUserAttributesRequest { /** *The user pool ID for the user pool where you want to update user attributes.
* @public */ UserPoolId: string | undefined; /** *The username of the user that you want to query or modify. The value of this parameter
* is typically your user's username, but it can be any of their alias attributes. If
* username isn't an alias attribute in your user pool, this value
* must be the sub of a local user or the username of a user from a
* third-party IdP.
An array of name-value pairs representing user attributes.
*For custom attributes, you must prepend the custom: prefix to the
* attribute name.
If your user pool requires verification before Amazon Cognito updates an attribute value that * you specify in this request, Amazon Cognito doesn’t immediately update the value of that * attribute. After your user receives and responds to a verification message to verify the * new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages * with the original attribute value until they verify the new value.
*To skip the verification message and update the value of an attribute that requires
* verification in the same API request, include the email_verified or
* phone_number_verified attribute, with a value of true. If
* you set the email_verified or phone_number_verified value for
* an email or phone_number attribute that requires verification
* to true, Amazon Cognito doesn’t send a verification message to your user.
A map of custom key-value pairs that you can provide as input for any custom workflows * that this action triggers.
*You create custom workflows by assigning Lambda functions to user pool
* triggers. When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes the
* function that is assigned to the custom message trigger. When Amazon Cognito
* invokes this function, it passes a JSON payload, which the function receives as input.
* This payload contains a clientMetadata attribute, which provides the data
* that you assigned to the ClientMetadata parameter in your AdminUpdateUserAttributes
* request. In your function code in Lambda, you can process the
* clientMetadata value to enhance your workflow for your specific
* needs.
For more information, see * Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
*When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the * following:
*Store the ClientMetadata value. This data is available only to Lambda * triggers that are assigned to a user pool to support custom workflows. If * your user pool configuration doesn't include triggers, the ClientMetadata * parameter serves no purpose.
*Validate the ClientMetadata value.
*Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive * information.
*Represents the response from the server for the request to update user attributes as * an administrator.
* @public */ export interface AdminUpdateUserAttributesResponse { } /** *The request to sign out of all devices, as an administrator.
* @public */ export interface AdminUserGlobalSignOutRequest { /** *The user pool ID.
* @public */ UserPoolId: string | undefined; /** *The username of the user that you want to query or modify. The value of this parameter
* is typically your user's username, but it can be any of their alias attributes. If
* username isn't an alias attribute in your user pool, this value
* must be the sub of a local user or the username of a user from a
* third-party IdP.
The global sign-out response, as an administrator.
* @public */ export interface AdminUserGlobalSignOutResponse { } /** * @public * @enum */ export declare const AdvancedSecurityEnabledModeType: { readonly AUDIT: "AUDIT"; readonly ENFORCED: "ENFORCED"; }; /** * @public */ export type AdvancedSecurityEnabledModeType = (typeof AdvancedSecurityEnabledModeType)[keyof typeof AdvancedSecurityEnabledModeType]; /** *Advanced security configuration options for additional authentication types in your * user pool, including custom * authentication.
* @public */ export interface AdvancedSecurityAdditionalFlowsType { /** *The operating mode of advanced security features in custom authentication with Custom * authentication challenge Lambda triggers.
* @public */ CustomAuthMode?: AdvancedSecurityEnabledModeType | undefined; } /** * @public * @enum */ export declare const AdvancedSecurityModeType: { readonly AUDIT: "AUDIT"; readonly ENFORCED: "ENFORCED"; readonly OFF: "OFF"; }; /** * @public */ export type AdvancedSecurityModeType = (typeof AdvancedSecurityModeType)[keyof typeof AdvancedSecurityModeType]; /** * @public * @enum */ export declare const AliasAttributeType: { readonly EMAIL: "email"; readonly PHONE_NUMBER: "phone_number"; readonly PREFERRED_USERNAME: "preferred_username"; }; /** * @public */ export type AliasAttributeType = (typeof AliasAttributeType)[keyof typeof AliasAttributeType]; /** * @public * @enum */ export declare const AuthFactorType: { readonly EMAIL_OTP: "EMAIL_OTP"; readonly PASSWORD: "PASSWORD"; readonly SMS_OTP: "SMS_OTP"; readonly WEB_AUTHN: "WEB_AUTHN"; }; /** * @public */ export type AuthFactorType = (typeof AuthFactorType)[keyof typeof AuthFactorType]; /** *The settings for Amazon Pinpoint analytics configuration. With an analytics configuration, * your application can collect user-activity metrics for user notifications with a Amazon Pinpoint * campaign.
*Amazon Pinpoint isn't available in all Amazon Web Services Regions. For a list of available Regions, see * Amazon Cognito and Amazon Pinpoint Region availability.
*This data type is a request parameter of CreateUserPoolClient and UpdateUserPoolClient, and a response parameter of * DescribeUserPoolClient.
* @public */ export interface AnalyticsConfigurationType { /** *Your Amazon Pinpoint project ID.
* @public */ ApplicationId?: string | undefined; /** *The Amazon Resource Name (ARN) of an Amazon Pinpoint project that you want to connect to
* your user pool app client. Amazon Cognito publishes events to the Amazon Pinpoint project that
* ApplicationArn declares. You can also configure your application to
* pass an endpoint ID in the AnalyticsMetadata parameter of sign-in
* operations. The endpoint ID is information about the destination for push
* notifications
The ARN of an Identity and Access Management role that has the permissions required for Amazon Cognito to publish * events to Amazon Pinpoint analytics.
* @public */ RoleArn?: string | undefined; /** *The external ID of the role that Amazon Cognito assumes to send * analytics data to Amazon Pinpoint.
* @public */ ExternalId?: string | undefined; /** *If UserDataShared is true, Amazon Cognito includes user data in the
* events that it publishes to Amazon Pinpoint analytics.
An image file from a managed login branding style in a user pool.
*This data type is a request parameter of CreateManagedLoginBranding and UpdateManagedLoginBranding, and a response parameter of * DescribeManagedLoginBranding.
* @public */ export interface AssetType { /** *The category that the image corresponds to in your managed login configuration. * Managed login has asset categories for different types of logos, backgrounds, and * icons.
* @public */ Category: AssetCategoryType | undefined; /** *The display-mode target of the asset: light, dark, or browser-adaptive. For example, * Amazon Cognito displays a dark-mode image only when the browser or application is in dark mode, * but displays a browser-adaptive file in all contexts.
* @public */ ColorMode: ColorSchemeModeType | undefined; /** *The file type of the image file.
* @public */ Extension: AssetExtensionType | undefined; /** *The image file, in Base64-encoded binary.
* @public */ Bytes?: Uint8Array | undefined; /** *The ID of the asset.
* @public */ ResourceId?: string | undefined; } /** * @public */ export interface AssociateSoftwareTokenRequest { /** *A valid access token that Amazon Cognito issued to the user whose software token you want to * generate.
* @public */ AccessToken?: string | undefined; /** *The session that should be passed both ways in challenge-response calls to the * service. This allows authentication of the user as part of the MFA setup process.
* @public */ Session?: string | undefined; } /** * @public */ export interface AssociateSoftwareTokenResponse { /** *A unique generated shared secret code that is used in the TOTP algorithm to generate a * one-time code.
* @public */ SecretCode?: string | undefined; /** *The session that should be passed both ways in challenge-response calls to the * service. This allows authentication of the user as part of the MFA setup process.
* @public */ Session?: string | undefined; } /** *This exception is thrown if two or more modifications are happening * concurrently.
* @public */ export declare class ConcurrentModificationException extends __BaseException { readonly name: "ConcurrentModificationException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThis exception is thrown when WAF doesn't allow your request based on a web * ACL that's associated with your user pool.
* @public */ export declare class ForbiddenException extends __BaseException { readonly name: "ForbiddenException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeRepresents the request to change a user password.
* @public */ export interface ChangePasswordRequest { /** *The user's previous password. Required if the user has a password. If the user * has no password and only signs in with passwordless authentication options, you can omit * this parameter.
* @public */ PreviousPassword?: string | undefined; /** *The new password.
* @public */ ProposedPassword: string | undefined; /** *A valid access token that Amazon Cognito issued to the user whose password you want to * change.
* @public */ AccessToken: string | undefined; } /** *The response from the server to the change password request.
* @public */ export interface ChangePasswordResponse { } /** * @public */ export interface CompleteWebAuthnRegistrationRequest { /** *A valid access token that Amazon Cognito issued to the user whose passkey registration you want * to verify.
* @public */ AccessToken: string | undefined; /** *A RegistrationResponseJSON public-key credential response from the * user's passkey provider.
* @public */ Credential: __DocumentType | undefined; } /** * @public */ export interface CompleteWebAuthnRegistrationResponse { } /** *This exception is thrown when the challenge from StartWebAuthn
* registration has expired.
This exception is thrown when the access token is for a different client than the one
* in the original StartWebAuthnRegistration request.
This exception is thrown when a user presents passkey credentials from an unsupported * device or provider.
* @public */ export declare class WebAuthnCredentialNotSupportedException extends __BaseException { readonly name: "WebAuthnCredentialNotSupportedException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThis exception is thrown when the passkey feature isn't enabled for the user * pool.
* @public */ export declare class WebAuthnNotEnabledException extends __BaseException { readonly name: "WebAuthnNotEnabledException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThis exception is thrown when the passkey credential's registration origin does not * align with the user pool relying party id.
* @public */ export declare class WebAuthnOriginNotAllowedException extends __BaseException { readonly name: "WebAuthnOriginNotAllowedException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThis exception is thrown when the given passkey credential is associated with a * different relying party ID than the user pool relying party ID.
* @public */ export declare class WebAuthnRelyingPartyMismatchException extends __BaseException { readonly name: "WebAuthnRelyingPartyMismatchException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeA Secure Remote Password (SRP) value that your application generates when you register * a user's device. For more information, see Getting a device key.
*This data type is a request parameter of ConfirmDevice.
* @public */ export interface DeviceSecretVerifierConfigType { /** *A password verifier for a user's device. Used in SRP authentication.
* @public */ PasswordVerifier?: string | undefined; /** *The salt that you want to use in SRP authentication with the user's device.
* @public */ Salt?: string | undefined; } /** *Confirms the device request.
* @public */ export interface ConfirmDeviceRequest { /** *A valid access token that Amazon Cognito issued to the user whose device you want to * confirm.
* @public */ AccessToken: string | undefined; /** *The device key.
* @public */ DeviceKey: string | undefined; /** *The configuration of the device secret verifier.
* @public */ DeviceSecretVerifierConfig?: DeviceSecretVerifierConfigType | undefined; /** *The device name.
* @public */ DeviceName?: string | undefined; } /** *Confirms the device response.
* @public */ export interface ConfirmDeviceResponse { /** *Indicates whether the user confirmation must confirm the device response.
* @public */ UserConfirmationNecessary?: boolean | undefined; } /** *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 data type is a request parameter of public-client authentication operations like * InitiateAuth and RespondToAuthChallenge.
* @public */ export interface UserContextDataType { /** *The source IP address of your user's device.
* @public */ IpAddress?: string | undefined; /** *Encoded device-fingerprint details that your app collected with the Amazon Cognito * context data collection library. For more information, see Adding user device and session data to API requests.
* @public */ EncodedData?: string | undefined; } /** *The request representing the confirmation for a password reset.
* @public */ export interface ConfirmForgotPasswordRequest { /** *The app client ID of the app associated with the user pool.
* @public */ ClientId: string | undefined; /** *A keyed-hash message authentication code (HMAC) calculated using the secret key of a
* user pool client and username plus the client ID in the message. For more information
* about SecretHash, see Computing secret hash values.
The username of the user that you want to query or modify. The value of this parameter
* is typically your user's username, but it can be any of their alias attributes. If
* username isn't an alias attribute in your user pool, this value
* must be the sub of a local user or the username of a user from a
* third-party IdP.
The confirmation code from your user's request to reset their password. For more * information, see ForgotPassword.
* @public */ ConfirmationCode: string | undefined; /** *The new password that your user wants to set.
* @public */ Password: string | undefined; /** *The Amazon Pinpoint analytics metadata for collecting metrics for
* ConfirmForgotPassword calls.
Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito * when it makes API requests.
* @public */ UserContextData?: UserContextDataType | undefined; /** *A map of custom key-value pairs that you can provide as input for any custom workflows * that this action triggers.
*You create custom workflows by assigning Lambda functions to user pool triggers.
* When you use the ConfirmForgotPassword API action, Amazon Cognito invokes the function that is
* assigned to the post confirmation trigger. When Amazon Cognito invokes this
* function, it passes a JSON payload, which the function receives as input. This payload
* contains a clientMetadata attribute, which provides the data that you
* assigned to the ClientMetadata parameter in your ConfirmForgotPassword request. In your
* function code in Lambda, you can process the clientMetadata value to
* enhance your workflow for your specific needs.
For more information, see * Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
*When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the * following:
*Store the ClientMetadata value. This data is available only to Lambda * triggers that are assigned to a user pool to support custom workflows. If * your user pool configuration doesn't include triggers, the ClientMetadata * parameter serves no purpose.
*Validate the ClientMetadata value.
*Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive * information.
*The response from the server that results from a user's request to retrieve a * forgotten password.
* @public */ export interface ConfirmForgotPasswordResponse { } /** *Represents the request to confirm registration of a user.
* @public */ export interface ConfirmSignUpRequest { /** *The ID of the app client associated with the user pool.
* @public */ ClientId: string | undefined; /** *A keyed-hash message authentication code (HMAC) calculated using the secret key of a * user pool client and username plus the client ID in the message.
* @public */ SecretHash?: string | undefined; /** *The username of the user that you want to query or modify. The value of this parameter
* is typically your user's username, but it can be any of their alias attributes. If
* username isn't an alias attribute in your user pool, this value
* must be the sub of a local user or the username of a user from a
* third-party IdP.
The confirmation code sent by a user's request to confirm registration.
* @public */ ConfirmationCode: string | undefined; /** *Boolean to be specified to force user confirmation irrespective of existing alias. By
* default set to False. If this parameter is set to True and the
* phone number/email used for sign up confirmation already exists as an alias with a
* different user, the API call will migrate the alias from the previous user to the newly
* created user being confirmed. If set to False, the API will throw an
* AliasExistsException error.
The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp
* calls.
Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito * when it makes API requests.
* @public */ UserContextData?: UserContextDataType | undefined; /** *A map of custom key-value pairs that you can provide as input for any custom workflows * that this action triggers.
*You create custom workflows by assigning Lambda functions to user pool
* triggers. When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is
* assigned to the post confirmation trigger. When Amazon Cognito invokes this
* function, it passes a JSON payload, which the function receives as input. This payload
* contains a clientMetadata attribute, which provides the data that you
* assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your function
* code in Lambda, you can process the clientMetadata value to
* enhance your workflow for your specific needs.
For more information, see * Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
*When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the * following:
*Store the ClientMetadata value. This data is available only to Lambda * triggers that are assigned to a user pool to support custom workflows. If * your user pool configuration doesn't include triggers, the ClientMetadata * parameter serves no purpose.
*Validate the ClientMetadata value.
*Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive * information.
*The optional session ID from a SignUp API request. You can sign in a user
* directly from the sign-up process with the USER_AUTH authentication
* flow.
Represents the response from the server for the registration confirmation.
* @public */ export interface ConfirmSignUpResponse { /** *You can automatically sign users in with the one-time password that they provided in a
* successful ConfirmSignUp request. To do this, pass the Session
* parameter from the ConfirmSignUp response in the Session
* parameter of an InitiateAuth or AdminInitiateAuth request.
The name of the group. Must be unique.
* @public */ GroupName: string | undefined; /** *The user pool ID for the user pool.
* @public */ UserPoolId: string | undefined; /** *A string containing the description of the group.
* @public */ Description?: string | undefined; /** *The role Amazon Resource Name (ARN) for the group.
* @public */ RoleArn?: string | undefined; /** *A non-negative integer value that specifies the precedence of this group relative to
* the other groups that a user can belong to in the user pool. Zero is the highest
* precedence value. Groups with lower Precedence values take precedence over
* groups with higher or null Precedence values. If a user belongs to two or
* more groups, it is the group with the lowest precedence value whose role ARN is given in
* the user's tokens for the cognito:roles and
* cognito:preferred_role claims.
Two groups can have the same Precedence value. If this happens, neither
* group takes precedence over the other. If two groups with the same
* Precedence have the same role ARN, that role is used in the
* cognito:preferred_role claim in tokens for users in each group. If the
* two groups have different role ARNs, the cognito:preferred_role claim isn't
* set in users' tokens.
The default Precedence value is null. The maximum Precedence
* value is 2^31-1.
The group object for the group.
* @public */ Group?: GroupType | undefined; } /** *This exception is thrown when Amazon Cognito encounters a group that already exists in the user * pool.
* @public */ export declare class GroupExistsException extends __BaseException { readonly name: "GroupExistsException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe user pool ID.
* @public */ UserPoolId: string | undefined; /** *The IdP name.
* @public */ ProviderName: string | undefined; /** *The IdP type.
* @public */ ProviderType: IdentityProviderTypeType | undefined; /** *The scopes, URLs, and identifiers for your external identity provider. The following
* examples describe the provider detail keys for each IdP type. These values and their
* schema are subject to change. Social IdP authorize_scopes values must match
* the values listed here.
Amazon Cognito accepts the following elements when it can't discover endpoint
* URLs from oidc_issuer: attributes_url,
* authorize_url, jwks_uri,
* token_url.
Create or update request: "ProviderDetails": \{
* "attributes_request_method": "GET", "attributes_url":
* "https://auth.example.com/userInfo", "authorize_scopes": "openid profile
* email", "authorize_url": "https://auth.example.com/authorize",
* "client_id": "1example23456789", "client_secret":
* "provider-app-client-secret", "jwks_uri":
* "https://auth.example.com/.well-known/jwks.json", "oidc_issuer":
* "https://auth.example.com", "token_url": "https://example.com/token"
* \}
*
Describe response: "ProviderDetails": \{ "attributes_request_method":
* "GET", "attributes_url": "https://auth.example.com/userInfo",
* "attributes_url_add_attributes": "false", "authorize_scopes": "openid
* profile email", "authorize_url": "https://auth.example.com/authorize",
* "client_id": "1example23456789", "client_secret":
* "provider-app-client-secret", "jwks_uri":
* "https://auth.example.com/.well-known/jwks.json", "oidc_issuer":
* "https://auth.example.com", "token_url": "https://example.com/token"
* \}
*
Create or update request with Metadata URL: "ProviderDetails": \{ "IDPInit": "true",
* "IDPSignout": "true", "EncryptedResponses" : "true", "MetadataURL":
* "https://auth.example.com/sso/saml/metadata", "RequestSigningAlgorithm":
* "rsa-sha256" \}
*
Create or update request with Metadata file: "ProviderDetails": \{ "IDPInit": "true",
* "IDPSignout": "true", "EncryptedResponses" : "true",
* "MetadataFile": "[metadata XML]", "RequestSigningAlgorithm":
* "rsa-sha256" \}
*
The value of MetadataFile must be the plaintext metadata document with all
* quote (") characters escaped by backslashes.
Describe response: "ProviderDetails": \{ "IDPInit": "true",
* "IDPSignout": "true", "EncryptedResponses" : "true", "ActiveEncryptionCertificate": "[certificate]",
* "MetadataURL": "https://auth.example.com/sso/saml/metadata", "RequestSigningAlgorithm":
* "rsa-sha256", "SLORedirectBindingURI":
* "https://auth.example.com/slo/saml", "SSORedirectBindingURI":
* "https://auth.example.com/sso/saml" \}
*
Create or update request: "ProviderDetails": \{ "authorize_scopes":
* "profile postal_code", "client_id":
* "amzn1.application-oa2-client.1example23456789", "client_secret":
* "provider-app-client-secret"
*
Describe response: "ProviderDetails": \{ "attributes_url":
* "https://api.amazon.com/user/profile", "attributes_url_add_attributes":
* "false", "authorize_scopes": "profile postal_code", "authorize_url":
* "https://www.amazon.com/ap/oa", "client_id":
* "amzn1.application-oa2-client.1example23456789", "client_secret":
* "provider-app-client-secret", "token_request_method": "POST",
* "token_url": "https://api.amazon.com/auth/o2/token" \}
*
Create or update request: "ProviderDetails": \{ "authorize_scopes":
* "email profile openid", "client_id":
* "1example23456789.apps.googleusercontent.com", "client_secret":
* "provider-app-client-secret" \}
*
Describe response: "ProviderDetails": \{ "attributes_url":
* "https://people.googleapis.com/v1/people/me?personFields=",
* "attributes_url_add_attributes": "true", "authorize_scopes": "email
* profile openid", "authorize_url":
* "https://accounts.google.com/o/oauth2/v2/auth", "client_id":
* "1example23456789.apps.googleusercontent.com", "client_secret":
* "provider-app-client-secret", "oidc_issuer":
* "https://accounts.google.com", "token_request_method": "POST",
* "token_url": "https://www.googleapis.com/oauth2/v4/token"
* \}
*
Create or update request: "ProviderDetails": \{ "authorize_scopes":
* "email name", "client_id": "com.example.cognito", "private_key": "1EXAMPLE",
* "key_id": "2EXAMPLE", "team_id": "3EXAMPLE" \}
*
Describe response: "ProviderDetails": \{
* "attributes_url_add_attributes": "false", "authorize_scopes": "email
* name", "authorize_url": "https://appleid.apple.com/auth/authorize",
* "client_id": "com.example.cognito", "key_id": "1EXAMPLE", "oidc_issuer":
* "https://appleid.apple.com", "team_id": "2EXAMPLE",
* "token_request_method": "POST", "token_url":
* "https://appleid.apple.com/auth/token" \}
*
Create or update request: "ProviderDetails": \{ "api_version": "v17.0",
* "authorize_scopes": "public_profile, email", "client_id": "1example23456789",
* "client_secret": "provider-app-client-secret" \}
*
Describe response: "ProviderDetails":
* \{ "api_version": "v17.0", "attributes_url": "https://graph.facebook.com/v17.0/me?fields=",
* "attributes_url_add_attributes": "true", "authorize_scopes": "public_profile, email",
* "authorize_url": "https://www.facebook.com/v17.0/dialog/oauth", "client_id":
* "1example23456789", "client_secret": "provider-app-client-secret", "token_request_method":
* "GET", "token_url": "https://graph.facebook.com/v17.0/oauth/access_token" \}
*
A mapping of IdP attributes to standard and custom user pool attributes.
* @public */ AttributeMapping?: RecordA list of IdP identifiers.
* @public */ IdpIdentifiers?: string[] | undefined; } /** *A user pool identity provider (IdP). Contains information about a third-party IdP to a * user pool, the attributes that it populates to user profiles, and the trust relationship * between the IdP and your user pool.
*This data type is a response parameter of CreateIdentityProvider, DescribeIdentityProvider, GetIdentityProviderByIdentifier, and UpdateIdentityProvider.
* @public */ export interface IdentityProviderType { /** *The ID of the user pool associated with the IdP.
* @public */ UserPoolId?: string | undefined; /** *A friendly name for the IdP.
* @public */ ProviderName?: string | undefined; /** *The type of IdP. Either SAML, OIDC, or a named social identity provider.
* @public */ ProviderType?: IdentityProviderTypeType | undefined; /** *The scopes, URLs, and identifiers for your external identity provider. The following
* examples describe the provider detail keys for each IdP type. These values and their
* schema are subject to change. Social IdP authorize_scopes values must match
* the values listed here.
Amazon Cognito accepts the following elements when it can't discover endpoint
* URLs from oidc_issuer: attributes_url,
* authorize_url, jwks_uri,
* token_url.
Create or update request: "ProviderDetails": \{
* "attributes_request_method": "GET", "attributes_url":
* "https://auth.example.com/userInfo", "authorize_scopes": "openid profile
* email", "authorize_url": "https://auth.example.com/authorize",
* "client_id": "1example23456789", "client_secret":
* "provider-app-client-secret", "jwks_uri":
* "https://auth.example.com/.well-known/jwks.json", "oidc_issuer":
* "https://auth.example.com", "token_url": "https://example.com/token"
* \}
*
Describe response: "ProviderDetails": \{ "attributes_request_method":
* "GET", "attributes_url": "https://auth.example.com/userInfo",
* "attributes_url_add_attributes": "false", "authorize_scopes": "openid
* profile email", "authorize_url": "https://auth.example.com/authorize",
* "client_id": "1example23456789", "client_secret":
* "provider-app-client-secret", "jwks_uri":
* "https://auth.example.com/.well-known/jwks.json", "oidc_issuer":
* "https://auth.example.com", "token_url": "https://example.com/token"
* \}
*
Create or update request with Metadata URL: "ProviderDetails": \{ "IDPInit": "true",
* "IDPSignout": "true", "EncryptedResponses" : "true", "MetadataURL":
* "https://auth.example.com/sso/saml/metadata", "RequestSigningAlgorithm":
* "rsa-sha256" \}
*
Create or update request with Metadata file: "ProviderDetails": \{ "IDPInit": "true",
* "IDPSignout": "true", "EncryptedResponses" : "true",
* "MetadataFile": "[metadata XML]", "RequestSigningAlgorithm":
* "rsa-sha256" \}
*
The value of MetadataFile must be the plaintext metadata document with all
* quote (") characters escaped by backslashes.
Describe response: "ProviderDetails": \{ "IDPInit": "true",
* "IDPSignout": "true", "EncryptedResponses" : "true", "ActiveEncryptionCertificate": "[certificate]",
* "MetadataURL": "https://auth.example.com/sso/saml/metadata", "RequestSigningAlgorithm":
* "rsa-sha256", "SLORedirectBindingURI":
* "https://auth.example.com/slo/saml", "SSORedirectBindingURI":
* "https://auth.example.com/sso/saml" \}
*
Create or update request: "ProviderDetails": \{ "authorize_scopes":
* "profile postal_code", "client_id":
* "amzn1.application-oa2-client.1example23456789", "client_secret":
* "provider-app-client-secret"
*
Describe response: "ProviderDetails": \{ "attributes_url":
* "https://api.amazon.com/user/profile", "attributes_url_add_attributes":
* "false", "authorize_scopes": "profile postal_code", "authorize_url":
* "https://www.amazon.com/ap/oa", "client_id":
* "amzn1.application-oa2-client.1example23456789", "client_secret":
* "provider-app-client-secret", "token_request_method": "POST",
* "token_url": "https://api.amazon.com/auth/o2/token" \}
*
Create or update request: "ProviderDetails": \{ "authorize_scopes":
* "email profile openid", "client_id":
* "1example23456789.apps.googleusercontent.com", "client_secret":
* "provider-app-client-secret" \}
*
Describe response: "ProviderDetails": \{ "attributes_url":
* "https://people.googleapis.com/v1/people/me?personFields=",
* "attributes_url_add_attributes": "true", "authorize_scopes": "email
* profile openid", "authorize_url":
* "https://accounts.google.com/o/oauth2/v2/auth", "client_id":
* "1example23456789.apps.googleusercontent.com", "client_secret":
* "provider-app-client-secret", "oidc_issuer":
* "https://accounts.google.com", "token_request_method": "POST",
* "token_url": "https://www.googleapis.com/oauth2/v4/token"
* \}
*
Create or update request: "ProviderDetails": \{ "authorize_scopes":
* "email name", "client_id": "com.example.cognito", "private_key": "1EXAMPLE",
* "key_id": "2EXAMPLE", "team_id": "3EXAMPLE" \}
*
Describe response: "ProviderDetails": \{
* "attributes_url_add_attributes": "false", "authorize_scopes": "email
* name", "authorize_url": "https://appleid.apple.com/auth/authorize",
* "client_id": "com.example.cognito", "key_id": "1EXAMPLE", "oidc_issuer":
* "https://appleid.apple.com", "team_id": "2EXAMPLE",
* "token_request_method": "POST", "token_url":
* "https://appleid.apple.com/auth/token" \}
*
Create or update request: "ProviderDetails": \{ "api_version": "v17.0",
* "authorize_scopes": "public_profile, email", "client_id": "1example23456789",
* "client_secret": "provider-app-client-secret" \}
*
Describe response: "ProviderDetails":
* \{ "api_version": "v17.0", "attributes_url": "https://graph.facebook.com/v17.0/me?fields=",
* "attributes_url_add_attributes": "true", "authorize_scopes": "public_profile, email",
* "authorize_url": "https://www.facebook.com/v17.0/dialog/oauth", "client_id":
* "1example23456789", "client_secret": "provider-app-client-secret", "token_request_method":
* "GET", "token_url": "https://graph.facebook.com/v17.0/oauth/access_token" \}
*
A mapping of IdP attributes to standard and custom user pool attributes.
* @public */ AttributeMapping?: RecordA list of IdP identifiers. IdP identifiers are strings that represent friendly names
* or domain names of IdPs, for example MyIdP or
* auth.example.com. You can choose to route user authorization requests to
* the right IdP with either IdP identifiers or IdP names. For more information, see
* identity_provider and idp_identifier at Authorize endpoint.
The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
* human-readable format like ISO 8601 or a Java Date object.
The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
* human-readable format like ISO 8601 or a Java Date object.
The newly created IdP object.
* @public */ IdentityProvider: IdentityProviderType | undefined; } /** *This exception is thrown when the provider is already supported by the user * pool.
* @public */ export declare class DuplicateProviderException extends __BaseException { readonly name: "DuplicateProviderException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe ID of the user pool where you want to create a new branding style.
* @public */ UserPoolId: string | undefined; /** *The app client that you want to create the branding style for. Each style is * permanently linked to an app client. To change the style for an app client, delete the * existing style with DeleteManagedLoginBranding and create a new one.
* @public */ ClientId: string | undefined; /** *When true, applies the default branding style options. This option reverts to default * style options that are managed by Amazon Cognito. You can modify them later in the branding * designer.
*When you specify true for this option, you must also omit values for
* Settings and Assets in the request.
A JSON file, encoded as a Document type, with the the settings that you
* want to apply to your style.
An array of image files that you want to apply to roles like backgrounds, logos, and * icons. Each object must also indicate whether it is for dark mode, light mode, or * browser-adaptive mode.
* @public */ Assets?: AssetType[] | undefined; } /** *A managed login branding style that's assigned to a user pool app client.
*This data type is a response parameter of CreateManagedLoginBranding, UpdateManagedLoginBranding, DescribeManagedLoginBranding, and DescribeManagedLoginBrandingByClient.
* @public */ export interface ManagedLoginBrandingType { /** *The ID of the managed login branding style.
* @public */ ManagedLoginBrandingId?: string | undefined; /** *The user pool where the branding style is assigned.
* @public */ UserPoolId?: string | undefined; /** *When true, applies the default branding style options. This option reverts to a * "blank" style that you can modify later in the branding designer.
* @public */ UseCognitoProvidedValues?: boolean | undefined; /** *A JSON file, encoded as a Document type, with the the settings that you
* want to apply to your style.
An array of image files that you want to apply to roles like backgrounds, logos, and * icons. Each object must also indicate whether it is for dark mode, light mode, or * browser-adaptive mode.
* @public */ Assets?: AssetType[] | undefined; /** *The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
* human-readable format like ISO 8601 or a Java Date object.
The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
* human-readable format like ISO 8601 or a Java Date object.
The details of the branding style that you created.
* @public */ ManagedLoginBranding?: ManagedLoginBrandingType | undefined; } /** *This exception is thrown when you attempt to apply a managed login branding style to * an app client that already has an assigned style.
* @public */ export declare class ManagedLoginBrandingExistsException extends __BaseException { readonly name: "ManagedLoginBrandingExistsException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeOne custom scope associated with a user pool resource server. This data type is a
* member of ResourceServerScopeType. For more information, see
* Scopes, M2M, and API authorization with resource servers.
This data type is a request parameter of CreateResourceServer and a response parameter of DescribeResourceServer.
* @public */ export interface ResourceServerScopeType { /** *The name of the scope. Amazon Cognito renders custom scopes in the format
* resourceServerIdentifier/ScopeName. For example, if this parameter is
* exampleScope in the resource server with the identifier
* exampleResourceServer, you request and receive the scope
* exampleResourceServer/exampleScope.
A friendly description of a custom scope.
* @public */ ScopeDescription: string | undefined; } /** * @public */ export interface CreateResourceServerRequest { /** *The user pool ID for the user pool.
* @public */ UserPoolId: string | undefined; /** *A unique resource server identifier for the resource server. The identifier can be an
* API friendly name like solar-system-data. You can also set an API URL like
* https://solar-system-data-api.example.com as your identifier.
Amazon Cognito represents scopes in the access token in the format
* $resource-server-identifier/$scope. Longer scope-identifier strings
* increase the size of your access tokens.
A friendly name for the resource server.
* @public */ Name: string | undefined; /** *A list of scopes. Each scope is a key-value map with the keys name and
* description.
The details of a resource server configuration and associated custom scopes in a user * pool.
*This data type is a request parameter of CreateResourceServer and a response parameter of DescribeResourceServer.
* @public */ export interface ResourceServerType { /** *The ID of the user pool that contains the resource server configuration.
* @public */ UserPoolId?: string | undefined; /** *A unique resource server identifier for the resource server. The identifier can be an
* API friendly name like solar-system-data. You can also set an API URL like
* https://solar-system-data-api.example.com as your identifier.
Amazon Cognito represents scopes in the access token in the format
* $resource-server-identifier/$scope. Longer scope-identifier strings
* increase the size of your access tokens.
The name of the resource server.
* @public */ Name?: string | undefined; /** *A list of scopes that are defined for the resource server.
* @public */ Scopes?: ResourceServerScopeType[] | undefined; } /** * @public */ export interface CreateResourceServerResponse { /** *The newly created resource server.
* @public */ ResourceServer: ResourceServerType | undefined; } /** *Represents the request to create the user import job.
* @public */ export interface CreateUserImportJobRequest { /** *The job name for the user import job.
* @public */ JobName: string | undefined; /** *The user pool ID for the user pool that the users are being imported into.
* @public */ UserPoolId: string | undefined; /** *The role ARN for the Amazon CloudWatch Logs Logging role for the user import job.
* @public */ CloudWatchLogsRoleArn: string | undefined; } /** * @public * @enum */ export declare const UserImportJobStatusType: { readonly Created: "Created"; readonly Expired: "Expired"; readonly Failed: "Failed"; readonly InProgress: "InProgress"; readonly Pending: "Pending"; readonly Stopped: "Stopped"; readonly Stopping: "Stopping"; readonly Succeeded: "Succeeded"; }; /** * @public */ export type UserImportJobStatusType = (typeof UserImportJobStatusType)[keyof typeof UserImportJobStatusType]; /** *A user import job in a user pool. Describes the status of user import with a CSV file. * For more information, see Importing users into user pools from a CSV file.
*This data type is a request parameter of CreateUserImportJob, DescribeUserImportJob, ListUserImportJobs, StartUserImportJob, and StopUserImportJob.
* @public */ export interface UserImportJobType { /** *The friendly name of the user import job.
* @public */ JobName?: string | undefined; /** *The ID of the user import job.
* @public */ JobId?: string | undefined; /** *The ID of the user pool that the users are being imported into.
* @public */ UserPoolId?: string | undefined; /** *The pre-signed URL target for uploading the CSV file.
* @public */ PreSignedUrl?: string | undefined; /** *The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
* human-readable format like ISO 8601 or a Java Date object.
The date when the user import job was started.
* @public */ StartDate?: Date | undefined; /** *The date when the user import job was completed.
* @public */ CompletionDate?: Date | undefined; /** *The status of the user import job. One of the following:
*
* Created - The job was created but not started.
* Pending - A transition state. You have started the job, but it
* has not begun importing users yet.
* InProgress - The job has started, and users are being
* imported.
* Stopping - You have stopped the job, but the job has not stopped
* importing users yet.
* Stopped - You have stopped the job, and the job has stopped
* importing users.
* Succeeded - The job has completed successfully.
* Failed - The job has stopped due to an error.
* Expired - You created a job, but did not start the job within
* 24-48 hours. All data associated with the job was deleted, and the job can't be
* started.
The role Amazon Resource Name (ARN) for the Amazon CloudWatch Logging role for the user import * job. For more information, see "Creating the CloudWatch Logs IAM Role" in the Amazon Cognito Developer * Guide.
* @public */ CloudWatchLogsRoleArn?: string | undefined; /** *The number of users that were successfully imported.
* @public */ ImportedUsers?: number | undefined; /** *The number of users that were skipped.
* @public */ SkippedUsers?: number | undefined; /** *The number of users that couldn't be imported.
* @public */ FailedUsers?: number | undefined; /** *The message returned when the user import job is completed.
* @public */ CompletionMessage?: string | undefined; } /** *Represents the response from the server to the request to create the user import * job.
* @public */ export interface CreateUserImportJobResponse { /** *The job object that represents the user import job.
* @public */ UserImportJob?: UserImportJobType | undefined; } /** * @public * @enum */ export declare const DeletionProtectionType: { readonly ACTIVE: "ACTIVE"; readonly INACTIVE: "INACTIVE"; }; /** * @public */ export type DeletionProtectionType = (typeof DeletionProtectionType)[keyof typeof DeletionProtectionType]; /** *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.
To sign in with a remembered device, include DEVICE_KEY in the
* authentication parameters in your user's
* InitiateAuth request. If your app doesn't include a DEVICE_KEY
* parameter, the response from Amazon Cognito includes newly-generated DEVICE_KEY and
* DEVICE_GROUP_KEY values under NewDeviceMetadata. Store
* these values to use in future device-authentication requests.
When you provide a value for any property of DeviceConfiguration, you
* activate the device remembering for the user pool.
This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.
*When true, a remembered device can sign in with device authentication instead of SMS * and time-based one-time password (TOTP) factors for multi-factor authentication * (MFA).
*Whether or not ChallengeRequiredOnNewDevice is true, users who sign
* in with devices that have not been confirmed or remembered must still provide a
* second factor in a user pool that requires MFA.
When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a * * ConfirmDevice API request. In your app, create a prompt for your user to * choose whether they want to remember their device. Return the user's choice in an * UpdateDeviceStatus API request.
*When DeviceOnlyRememberedOnUserPrompt is false, Amazon
* Cognito immediately remembers devices that you register in a ConfirmDevice
* API request.
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.
*Amazon Cognito can send email messages with Amazon Simple Email Service resources in the Amazon Web Services Region where * you created your user pool, and in alternate Regions in some cases. For more * information on the supported Regions, see Email settings for Amazon Cognito user pools.
*This data type is a request parameter of CreateUserPool, UpdateUserPool, and SetUserPoolMfaConfig, and a response parameter of * CreateUserPool, UpdateUserPool, and GetUserPoolMfaConfig.
* @public */ export interface EmailConfigurationType { /** *The ARN of a verified email address or an address from a verified domain in Amazon SES. You
* can set a SourceArn email from a verified domain only with an API request.
* You can set a verified email address, but not an address in a verified domain, in the
* Amazon Cognito console. Amazon Cognito uses the email address that you provide in one of the following
* ways, depending on the value that you specify for the EmailSendingAccount
* parameter:
If you specify COGNITO_DEFAULT, Amazon Cognito uses this address as the
* custom FROM address when it emails your users using its built-in email
* account.
If you specify DEVELOPER, Amazon Cognito emails your users with this
* address by calling Amazon SES on your behalf.
The Region value of the SourceArn parameter must indicate a supported
* Amazon Web Services Region of your user pool. Typically, the Region in the SourceArn and
* the user pool Region are the same. For more information, see Amazon SES email configuration regions in the Amazon Cognito Developer
* Guide.
The destination to which the receiver of the email should reply.
* @public */ ReplyToEmailAddress?: string | undefined; /** *Specifies whether Amazon Cognito uses its built-in functionality to send your users email * messages, or uses your Amazon Simple Email Service email configuration. Specify one of the following * values:
*When Amazon Cognito emails your users, it uses its built-in email functionality. * When you use the default option, Amazon Cognito allows only a limited number of * emails each day for your user pool. For typical production environments, the * default email limit is less than the required delivery volume. To achieve a * higher delivery volume, specify DEVELOPER to use your Amazon SES email * configuration.
*To look up the email delivery limit for the default option, see Limits in the Amazon Cognito Developer * Guide.
*The default FROM address is no-reply@verificationemail.com.
* To customize the FROM address, provide the Amazon Resource Name (ARN) of an
* Amazon SES verified email address for the SourceArn
* parameter.
When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito * calls Amazon SES on your behalf to send email from your verified email address. * When you use this option, the email delivery limits are the same limits that * apply to your Amazon SES verified email address in your Amazon Web Services account.
*If you use this option, provide the ARN of an Amazon SES verified email address
* for the SourceArn parameter.
Before Amazon Cognito can email your users, it requires additional permissions to * call Amazon SES on your behalf. When you update your user pool with this option, * Amazon Cognito creates a service-linked role, which is a type of * role in your Amazon Web Services account. This role contains the permissions * that allow you to access Amazon SES and send email messages from your email * address. For more information about the service-linked role that Amazon Cognito * creates, see Using Service-Linked Roles for Amazon Cognito in the * Amazon Cognito Developer Guide.
*Either the sender’s email address or the sender’s name with their email address. For
* example, testuser@example.com or Test User
* . This address appears before the body of the
* email.
The set of configuration rules that can be applied to emails sent using Amazon Simple Email Service. A * configuration set is applied to an email by including a reference to the configuration * set in the headers of the email. Once applied, all of the rules in that configuration * set are applied to the email. Configuration sets can be used to apply the following * types of rules to emails:
*Amazon Simple Email Service can track the number of send, delivery, open, click, bounce, and * complaint events for each email sent. Use event publishing to send * information about these events to other Amazon Web Services services such as and * Amazon CloudWatch
*When leasing dedicated IP addresses with Amazon Simple Email Service, you can create groups * of IP addresses, called dedicated IP pools. You can then associate the * dedicated IP pools with configuration sets.
*The properties of a custom email sender Lambda trigger.
*This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.
* @public */ export interface CustomEmailLambdaVersionConfigType { /** *The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.
*You must use a LambdaVersion of V1_0 with a custom sender
* function.
The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.
* @public */ LambdaArn: string | undefined; } /** * @public * @enum */ export declare const CustomSMSSenderLambdaVersionType: { readonly V1_0: "V1_0"; }; /** * @public */ export type CustomSMSSenderLambdaVersionType = (typeof CustomSMSSenderLambdaVersionType)[keyof typeof CustomSMSSenderLambdaVersionType]; /** *The properties of a custom SMS sender Lambda trigger.
*This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.
* @public */ export interface CustomSMSLambdaVersionConfigType { /** *The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.
*You must use a LambdaVersion of V1_0 with a custom sender
* function.
The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.
* @public */ LambdaArn: string | undefined; } /** * @public * @enum */ export declare const PreTokenGenerationLambdaVersionType: { readonly V1_0: "V1_0"; readonly V2_0: "V2_0"; }; /** * @public */ export type PreTokenGenerationLambdaVersionType = (typeof PreTokenGenerationLambdaVersionType)[keyof typeof PreTokenGenerationLambdaVersionType]; /** *The properties of a pre token generation Lambda trigger.
*This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.
* @public */ export interface PreTokenGenerationVersionConfigType { /** *The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.
* @public */ LambdaVersion: PreTokenGenerationLambdaVersionType | undefined; /** *The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.
*This parameter and the PreTokenGeneration property of
* LambdaConfig have the same value. For new instances of pre token
* generation triggers, set LambdaArn.
A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible * stages of user pool operations. Triggers can modify the outcome of the operations that * invoked them.
*This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.
* @public */ export interface LambdaConfigType { /** *The configuration of a pre sign-up Lambda trigger in a user pool. This trigger * evaluates new users and can bypass confirmation, link a federated user profile, or block sign-up * requests.
* @public */ PreSignUp?: string | undefined; /** *A custom message Lambda trigger. This trigger is an opportunity to customize all SMS * and email messages from your user pool. When a custom message trigger is active, your * user pool routes all messages to a Lambda function that returns a runtime-customized * message subject and body for your user pool to deliver to a user.
* @public */ CustomMessage?: string | undefined; /** *The configuration of a post confirmation Lambda trigger in a user pool. This * trigger can take custom actions after a user confirms their user account and their email * address or phone number.
* @public */ PostConfirmation?: string | undefined; /** *The configuration of a pre authentication trigger in a user pool. This trigger * can evaluate and modify user sign-in events.
* @public */ PreAuthentication?: string | undefined; /** *The configuration of a post authentication Lambda trigger in a user pool. This * trigger can take custom actions after a user signs in.
* @public */ PostAuthentication?: string | undefined; /** *The configuration of a define auth challenge Lambda trigger, one of three triggers in * the sequence of the custom authentication challenge triggers.
* @public */ DefineAuthChallenge?: string | undefined; /** *The configuration of a create auth challenge Lambda trigger, one of three triggers in * the sequence of the custom authentication challenge triggers.
* @public */ CreateAuthChallenge?: string | undefined; /** *The configuration of a verify auth challenge Lambda trigger, one of three triggers in * the sequence of the custom authentication challenge triggers.
* @public */ VerifyAuthChallengeResponse?: string | undefined; /** *The legacy configuration of a pre token generation Lambda trigger in a user * pool.
*Set this parameter for legacy purposes. If you also set an ARN in
* PreTokenGenerationConfig, its value must be identical to
* PreTokenGeneration. For new instances of pre token generation triggers,
* set the LambdaArn of PreTokenGenerationConfig.
The configuration of a migrate user Lambda trigger in a user pool. This trigger * can create user profiles when users sign in or attempt to reset their password with * credentials that don't exist yet.
* @public */ UserMigration?: string | undefined; /** *The detailed configuration of a pre token generation Lambda trigger in a user pool. If
* you also set an ARN in PreTokenGeneration, its value must be identical to
* PreTokenGenerationConfig.
The configuration of a custom SMS sender Lambda trigger. This trigger routes all SMS * notifications from a user pool to a Lambda function that delivers the message using * custom logic.
* @public */ CustomSMSSender?: CustomSMSLambdaVersionConfigType | undefined; /** *The configuration of a custom email sender Lambda trigger. This trigger routes all * email notifications from a user pool to a Lambda function that delivers the message using * custom logic.
* @public */ CustomEmailSender?: CustomEmailLambdaVersionConfigType | undefined; /** *The ARN of an KMS key. Amazon Cognito uses the key to encrypt codes and temporary passwords sent to * custom sender Lambda triggers.
* @public */ KMSKeyID?: string | undefined; } /** * @public * @enum */ export declare const UserPoolMfaType: { readonly OFF: "OFF"; readonly ON: "ON"; readonly OPTIONAL: "OPTIONAL"; }; /** * @public */ export type UserPoolMfaType = (typeof UserPoolMfaType)[keyof typeof UserPoolMfaType]; /** *The password policy settings for a user pool, including complexity, history, and * length requirements.
*This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.
* @public */ export interface PasswordPolicyType { /** *The minimum length of the password in the policy that you have set. This value can't * be less than 6.
* @public */ MinimumLength?: number | undefined; /** *The requirement in a password policy that users must include at least one uppercase * letter in their password.
* @public */ RequireUppercase?: boolean | undefined; /** *The requirement in a password policy that users must include at least one lowercase * letter in their password.
* @public */ RequireLowercase?: boolean | undefined; /** *The requirement in a password policy that users must include at least one number in * their password.
* @public */ RequireNumbers?: boolean | undefined; /** *The requirement in a password policy that users must include at least one symbol in * their password.
* @public */ RequireSymbols?: boolean | undefined; /** *The number of previous passwords that you want Amazon Cognito to restrict each user from
* reusing. Users can't set a password that matches any of n previous
* passwords, where n is the value of PasswordHistorySize.
Password history isn't enforced and isn't displayed in DescribeUserPool responses when you set this value to
* 0 or don't provide it. To activate this setting,
* advanced security features must be active in your user pool.
The number of days a temporary password is valid in the password policy. If the user
* doesn't sign in during this time, an administrator must reset their password. Defaults
* to 7. If you submit a value of 0, Amazon Cognito treats it as a null
* value and sets TemporaryPasswordValidityDays to its default value.
When you set TemporaryPasswordValidityDays for a user pool, you can
* no longer set a value for the legacy UnusedAccountValidityDays
* parameter in that user pool.
The policy for allowed types of authentication in a user pool.
*This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.
* @public */ export interface SignInPolicyType { /** *The sign-in methods that a user pool supports as the first factor. You can permit * users to start authentication with a standard username and password, or with other * one-time password and hardware factors.
* @public */ AllowedFirstAuthFactors?: AuthFactorType[] | undefined; } /** *A list of user pool policies. Contains the policy that sets password-complexity * requirements.
*This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.
* @public */ export interface UserPoolPolicyType { /** *The password policy settings for a user pool, including complexity, history, and * length requirements.
* @public */ PasswordPolicy?: PasswordPolicyType | undefined; /** *The policy for allowed types of authentication in a user pool.
* @public */ SignInPolicy?: SignInPolicyType | undefined; } /** *User pool configuration for delivery of SMS messages with 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.
*This data type is a request parameter of CreateUserPool, UpdateUserPool, and SetUserPoolMfaConfig, and a response parameter of * CreateUserPool, UpdateUserPool, and GetUserPoolMfaConfig.
* @public */ export interface SmsConfigurationType { /** *The Amazon Resource Name (ARN) of the Amazon SNS caller. This is the ARN of the IAM role * in your Amazon Web Services account that Amazon Cognito will use to send SMS messages. SMS * messages are subject to a spending limit.
* @public */ SnsCallerArn: string | undefined; /** *The external ID provides additional security for your IAM role. You can use an
* ExternalId with the IAM role that you use with Amazon SNS to send SMS
* messages for your user pool. If you provide an ExternalId, your Amazon Cognito user
* pool includes it in the request to assume your IAM role. You can configure the role
* trust policy to require that Amazon Cognito, and any principal, provide the
* ExternalID. If you use the Amazon Cognito Management Console to create a role
* for SMS multi-factor authentication (MFA), Amazon Cognito creates a role with the required
* permissions and a trust policy that demonstrates use of the
* ExternalId.
For more information about the ExternalId of a role, see How to use an
* external ID when granting access to your Amazon Web Services resources to a third
* party.
The Amazon Web Services Region to use with Amazon SNS integration. You can choose the same Region as your * user pool, or a supported Legacy Amazon SNS alternate * Region.
** Amazon Cognito resources in the Asia Pacific (Seoul) Amazon Web Services Region must use your Amazon SNS * configuration in the Asia Pacific (Tokyo) Region. For more information, see SMS message settings for Amazon Cognito user pools.
* @public */ SnsRegion?: string | undefined; } /** *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.
This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.
* @public */ export interface UserAttributeUpdateSettingsType { /** *Requires that your user verifies their email address, phone number, or both before * Amazon Cognito updates the value of that attribute. When you update a user attribute that has * this option activated, Amazon Cognito sends a verification message to the new phone number or * email address. Amazon Cognito doesn’t change the value of the attribute until your user responds * to the verification message and confirms the new value.
*You can verify an updated email address or phone number with a VerifyUserAttribute API request. You can also call the AdminUpdateUserAttributes API and set email_verified or
* phone_number_verified to true.
When AttributesRequireVerificationBeforeUpdate is false, your user pool
* doesn't require that your users verify attribute changes before Amazon Cognito updates them. In a
* user pool where AttributesRequireVerificationBeforeUpdate is false, API
* operations that change attribute values can immediately update a user’s
* email or phone_number attribute.
The configuration of a user pool for username case sensitivity.
*This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.
* @public */ export interface UsernameConfigurationType { /** *Specifies whether user name case sensitivity will be applied for all users in the user
* pool through Amazon Cognito APIs. For most use cases, set case sensitivity to False
* (case insensitive) as a best practice. When usernames and email addresses are case
* insensitive, users can sign in as the same user when they enter a different
* capitalization of their user name.
Valid values include:
*Enables case sensitivity for all username input. When this option is set
* to true, users must sign in using the exact capitalization of
* their given username, such as “UserName”. This is the default value.
Enables case insensitivity for all username input. For example, when this
* option is set to false, users can sign in using
* username, USERNAME, or UserName.
* This option also enables both preferred_username and
* email alias to be case insensitive, in addition to the
* username attribute.
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.
For more information, see Adding advanced security to a user pool.
*This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.
* @public */ export interface UserPoolAddOnsType { /** *The operating mode of advanced security features for standard authentication types in * your user pool, including username-password and secure remote password (SRP) * authentication.
* @public */ AdvancedSecurityMode: AdvancedSecurityModeType | undefined; /** *Advanced security configuration options for additional authentication types in your * user pool, including custom * authentication.
* @public */ AdvancedSecurityAdditionalFlows?: AdvancedSecurityAdditionalFlowsType | undefined; } /** * @public * @enum */ export declare const UserPoolTierType: { readonly ESSENTIALS: "ESSENTIALS"; readonly LITE: "LITE"; readonly PLUS: "PLUS"; }; /** * @public */ export type UserPoolTierType = (typeof UserPoolTierType)[keyof typeof UserPoolTierType]; /** * @public * @enum */ export declare const DefaultEmailOptionType: { readonly CONFIRM_WITH_CODE: "CONFIRM_WITH_CODE"; readonly CONFIRM_WITH_LINK: "CONFIRM_WITH_LINK"; }; /** * @public */ export type DefaultEmailOptionType = (typeof DefaultEmailOptionType)[keyof typeof DefaultEmailOptionType]; /** *The template for the verification message that your user pool delivers to users who * set an email address or phone number attribute.
*This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.
* @public */ export interface VerificationMessageTemplateType { /** *The template for SMS messages that Amazon Cognito sends to your users.
* @public */ SmsMessage?: string | undefined; /** *The template for email messages that Amazon Cognito sends to your users. You can set an
* EmailMessage template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email
* messages with your own Amazon SES configuration.
The subject line for the email message template. You can set an
* EmailSubject template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email
* messages with your own Amazon SES configuration.
The email message template for sending a confirmation link to the user. You can set an
* EmailMessageByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email
* messages with your own Amazon SES configuration.
The subject line for the email message template for sending a confirmation link to the
* user. You can set an EmailSubjectByLink template only if the value of
* EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email
* messages with your own Amazon SES configuration.
The configuration of verification emails to contain a clickable link or a verification * code.
*For link, your template body must contain link text in the format \{##Click
* here##\}. "Click here" in the example is a customizable string. For code, your
* template body must contain a code placeholder in the format \{####\}.
Represents the request to create a user pool.
* @public */ export interface CreateUserPoolRequest { /** *A string used to name the user pool.
* @public */ PoolName: string | undefined; /** *The policies associated with the new user pool.
* @public */ Policies?: UserPoolPolicyType | undefined; /** *When active, DeletionProtection prevents accidental deletion of your user
* pool. Before you can delete a user pool that you have protected against deletion, you
* must deactivate this feature.
When you try to delete a protected user pool in a DeleteUserPool API request,
* Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool,
* send a new DeleteUserPool request after you deactivate deletion protection in an
* UpdateUserPool API request.
A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible * stages of authentication operations. Triggers can modify the outcome of the operations * that invoked them.
* @public */ LambdaConfig?: LambdaConfigType | undefined; /** *The attributes to be auto-verified. Possible values: email, phone_number.
* @public */ AutoVerifiedAttributes?: VerifiedAttributeType[] | undefined; /** *Attributes supported as an alias for this user pool. Possible values: phone_number, email, or * preferred_username.
* @public */ AliasAttributes?: AliasAttributeType[] | undefined; /** *Specifies whether a user can use an email address or phone number as a username when * they sign up.
* @public */ UsernameAttributes?: UsernameAttributeType[] | undefined; /** *This parameter is no longer used. See VerificationMessageTemplateType.
* @public */ SmsVerificationMessage?: string | undefined; /** *This parameter is no longer used. See VerificationMessageTemplateType.
* @public */ EmailVerificationMessage?: string | undefined; /** *This parameter is no longer used. See VerificationMessageTemplateType.
* @public */ EmailVerificationSubject?: string | undefined; /** *The template for the verification message that your user pool delivers to users who * set an email address or phone number attribute.
*Set the email message type that corresponds to your DefaultEmailOption
* selection. For CONFIRM_WITH_LINK, specify an
* EmailMessageByLink and leave EmailMessage blank. For
* CONFIRM_WITH_CODE, specify an EmailMessage and leave
* EmailMessageByLink blank. When you supply both parameters with either
* choice, Amazon Cognito returns an error.
A string representing the SMS authentication message.
* @public */ SmsAuthenticationMessage?: string | undefined; /** *Specifies MFA configuration details.
* @public */ MfaConfiguration?: UserPoolMfaType | undefined; /** *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.
The device-remembering configuration for a user pool. A null value indicates that you * have deactivated device remembering in your user pool.
*When you provide a value for any DeviceConfiguration field, you
* activate the Amazon Cognito device-remembering feature.
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.
* @public */ EmailConfiguration?: EmailConfigurationType | undefined; /** *The SMS configuration with 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.
* @public */ SmsConfiguration?: SmsConfigurationType | undefined; /** *The tag keys and values to assign to the 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.
* @public */ UserPoolTags?: RecordThe configuration for AdminCreateUser requests.
An array of schema attributes for the new user pool. These attributes can be standard * or custom attributes.
* @public */ Schema?: SchemaAttributeType[] | undefined; /** *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.
For more information, see Adding advanced security to a user pool.
* @public */ UserPoolAddOns?: UserPoolAddOnsType | undefined; /** *Case sensitivity on the username input for the selected sign-in option. When case
* sensitivity is set to False (case insensitive), users can sign in with any
* combination of capital and lowercase letters. For example, username,
* USERNAME, or UserName, or for email,
* email@example.com or EMaiL@eXamplE.Com. For most use
* cases, set case sensitivity to False (case insensitive) as a best practice.
* When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in
* case as the same user, and prevents a case variation from being assigned to the same
* attribute for a different user.
This configuration is immutable after you set it. For more information, see UsernameConfigurationType.
* @public */ UsernameConfiguration?: UsernameConfigurationType | undefined; /** *The available verified method a user can use to recover their password when they call
* ForgotPassword. You can use this setting to define a preferred method
* when a user has more than one method available. With this setting, SMS doesn't qualify
* for a valid password recovery mechanism if the user also has SMS multi-factor
* authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy
* behavior to determine the recovery method where SMS is preferred through email.
The user pool feature plan, or tier. This parameter determines the
* eligibility of the user pool for features like managed login, access-token
* customization, and threat protection. Defaults to ESSENTIALS.
The configuration of a user pool.
*This data type is a response parameter of CreateUserPool, UpdateUserPool, and DescribeUserPool.
* @public */ export interface UserPoolType { /** *The ID of the user pool.
* @public */ Id?: string | undefined; /** *The name of the user pool.
* @public */ Name?: string | undefined; /** *A list of user pool policies. Contains the policy that sets password-complexity * requirements.
* @public */ Policies?: UserPoolPolicyType | undefined; /** *When active, DeletionProtection prevents accidental deletion of your user
* pool. Before you can delete a user pool that you have protected against deletion, you
* must deactivate this feature.
When you try to delete a protected user pool in a DeleteUserPool API request,
* Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool,
* send a new DeleteUserPool request after you deactivate deletion protection in an
* UpdateUserPool API request.
A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible * stages of user pool operations. Triggers can modify the outcome of the operations that * invoked them.
* @public */ LambdaConfig?: LambdaConfigType | undefined; /** * @deprecated * *This parameter is no longer used.
* @public */ Status?: StatusType | undefined; /** *The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
* human-readable format like ISO 8601 or a Java Date object.
The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
* human-readable format like ISO 8601 or a Java Date object.
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.
Developer-only attributes are a legacy feature of user pools, and are read-only to all * app clients. You can create and update developer-only attributes only with * IAM-authenticated API operations. Use app client read/write permissions instead.
* @public */ SchemaAttributes?: SchemaAttributeType[] | undefined; /** *The attributes that are auto-verified in a user pool.
* @public */ AutoVerifiedAttributes?: VerifiedAttributeType[] | undefined; /** *Attributes supported as an alias for this user pool. An alias is an attribute that * users can enter as an alternative username. Possible values: phone_number, email, or preferred_username.
* @public */ AliasAttributes?: AliasAttributeType[] | undefined; /** *Specifies whether a user can use an email address or phone number as a username when * they sign up.
* @public */ UsernameAttributes?: UsernameAttributeType[] | undefined; /** *This parameter is no longer used. See VerificationMessageTemplateType.
* @public */ SmsVerificationMessage?: string | undefined; /** *This parameter is no longer used. See VerificationMessageTemplateType.
* @public */ EmailVerificationMessage?: string | undefined; /** *This parameter is no longer used. See VerificationMessageTemplateType.
* @public */ EmailVerificationSubject?: string | undefined; /** *The template for the verification message that your user pool delivers to users who * set an email address or phone number attribute.
* @public */ VerificationMessageTemplate?: VerificationMessageTemplateType | undefined; /** *The contents of the SMS authentication message.
* @public */ SmsAuthenticationMessage?: string | undefined; /** *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.
Can be one of the following values:
*
* OFF - MFA tokens aren't required and can't be specified during user
* registration.
* ON - MFA tokens are required for all user registrations. You can
* only specify required when you're initially creating a user pool.
* OPTIONAL - Users have the option when registering to create an MFA
* token.
The device-remembering configuration for a user pool. A null value indicates that you * have deactivated device remembering in your user pool.
*When you provide a value for any DeviceConfiguration field, you
* activate the Amazon Cognito device-remembering feature.
A number estimating the size of the user pool.
* @public */ EstimatedNumberOfUsers?: number | undefined; /** *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.
* @public */ EmailConfiguration?: EmailConfigurationType | undefined; /** *User pool configuration for delivery of SMS messages with 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.
* @public */ SmsConfiguration?: SmsConfigurationType | undefined; /** *The tags that are assigned to the 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.
* @public */ UserPoolTags?: RecordThe reason why the SMS configuration can't send the messages to your users.
*This message might include comma-separated values to describe why your SMS * configuration can't send messages to user pool end users.
*The Identity and Access Management role that Amazon Cognito uses to send SMS messages isn't properly * configured. For more information, see SmsConfigurationType.
*The Amazon Web Services account is in the SNS SMS Sandbox and messages will * only reach verified end users. This parameter won’t get populated with * SNSSandbox if the user creating the user pool doesn’t have SNS permissions. * To learn how to move your Amazon Web Services account out of the sandbox, see * Moving out * of the SMS sandbox.
*Deprecated. Review error codes from API requests with
* EventSource:cognito-idp.amazonaws.com in CloudTrail for
* information about problems with user pool email configuration.
The domain prefix, if the user pool has a domain associated with it.
* @public */ Domain?: string | undefined; /** *A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use
* a custom domain to host the sign-up and sign-in pages for your application. An example
* of a custom domain name might be auth.example.com.
For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
* @public */ CustomDomain?: string | undefined; /** *The configuration for AdminCreateUser requests.
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.
For more information, see Adding advanced security to a user pool.
* @public */ UserPoolAddOns?: UserPoolAddOnsType | undefined; /** *Case sensitivity of the username input for the selected sign-in option. When case
* sensitivity is set to False (case insensitive), users can sign in with any
* combination of capital and lowercase letters. For example, username,
* USERNAME, or UserName, or for email,
* email@example.com or EMaiL@eXamplE.Com. For most use
* cases, set case sensitivity to False (case insensitive) as a best practice.
* When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in
* case as the same user, and prevents a case variation from being assigned to the same
* attribute for a different user.
This configuration is immutable after you set it. For more information, see UsernameConfigurationType.
* @public */ UsernameConfiguration?: UsernameConfigurationType | undefined; /** *The Amazon Resource Name (ARN) of the user pool.
* @public */ Arn?: string | undefined; /** *The available verified method a user can use to recover their password when they call
* ForgotPassword. You can use this setting to define a preferred method
* when a user has more than one method available. With this setting, SMS doesn't qualify
* for a valid password recovery mechanism if the user also has SMS multi-factor
* authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy
* behavior to determine the recovery method where SMS is preferred through email.
The user pool feature plan, or tier. This parameter determines the
* eligibility of the user pool for features like managed login, access-token
* customization, and threat protection. Defaults to ESSENTIALS.
Represents the response from the server for the request to create a user pool.
* @public */ export interface CreateUserPoolResponse { /** *A container for the user pool details.
* @public */ UserPool?: UserPoolType | undefined; } /** *This exception is thrown when a feature you attempted to configure isn't * available in your current feature plan.
* @public */ export declare class FeatureUnavailableInTierException extends __BaseException { readonly name: "FeatureUnavailableInTierException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThis exception is thrown when you've attempted to change your feature plan but * the operation isn't permitted.
* @public */ export declare class TierChangeNotAllowedException extends __BaseException { readonly name: "TierChangeNotAllowedException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThis exception is thrown when a user pool tag can't be set or updated.
* @public */ export declare class UserPoolTaggingException extends __BaseException { readonly name: "UserPoolTaggingException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe time units that, with IdTokenValidity,
* AccessTokenValidity, and RefreshTokenValidity, set and
* display the duration of ID, access, and refresh tokens for an app client. You can assign
* a separate token validity unit to each type of token.
This data type is a request parameter of CreateUserPoolClient and UpdateUserPoolClient, and a response parameter of * DescribeUserPoolClient.
* @public */ export interface TokenValidityUnitsType { /** * A time unit for the value that you set in the AccessTokenValidity
* parameter. The default AccessTokenValidity time unit is hours.
* AccessTokenValidity duration can range from five minutes to one
* day.
A time unit for the value that you set in the IdTokenValidity parameter.
* The default IdTokenValidity time unit is hours.
* IdTokenValidity duration can range from five minutes to one day.
A time unit for the value that you set in the RefreshTokenValidity
* parameter. The default RefreshTokenValidity time unit is days.
* RefreshTokenValidity duration can range from 60 minutes to 10
* years.
Represents the request to create a user pool client.
* @public */ export interface CreateUserPoolClientRequest { /** *The user pool ID for the user pool where you want to create a user pool client.
* @public */ UserPoolId: string | undefined; /** *The client name for the user pool client you would like to create.
* @public */ ClientName: string | undefined; /** *Boolean to specify whether you want to generate a secret for the user pool client * being created.
* @public */ GenerateSecret?: boolean | undefined; /** *The refresh token time limit. After this limit expires, your user can't use
* their refresh token. To specify the time unit for RefreshTokenValidity as
* seconds, minutes, hours, or days,
* set a TokenValidityUnits value in your API request.
For example, when you set RefreshTokenValidity as 10 and
* TokenValidityUnits as days, your user can refresh their session
* and retrieve new access and ID tokens for 10 days.
The default time unit for RefreshTokenValidity in an API request is days.
* You can't set RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the
* value with the default value of 30 days. Valid range is displayed below
* in seconds.
If you don't specify otherwise in the configuration of your app client, your refresh * tokens are valid for 30 days.
* @public */ RefreshTokenValidity?: number | undefined; /** *The access token time limit. After this limit expires, your user can't use
* their access token. To specify the time unit for AccessTokenValidity as
* seconds, minutes, hours, or days,
* set a TokenValidityUnits value in your API request.
For example, when you set AccessTokenValidity to 10 and
* TokenValidityUnits to hours, your user can authorize access with
* their access token for 10 hours.
The default time unit for AccessTokenValidity in an API request is hours.
* Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your access * tokens are valid for one hour.
* @public */ AccessTokenValidity?: number | undefined; /** *The ID token time limit. After this limit expires, your user can't use
* their ID token. To specify the time unit for IdTokenValidity as
* seconds, minutes, hours, or days,
* set a TokenValidityUnits value in your API request.
For example, when you set IdTokenValidity as 10 and
* TokenValidityUnits as hours, your user can authenticate their
* session with their ID token for 10 hours.
The default time unit for IdTokenValidity in an API request is hours.
* Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your ID * tokens are valid for one hour.
* @public */ IdTokenValidity?: number | undefined; /** *The units in which the validity times are represented. The default unit for * RefreshToken is days, and default for ID and access tokens are hours.
* @public */ TokenValidityUnits?: TokenValidityUnitsType | undefined; /** *The list of user attributes that you want your app client to have read access to. * After your user authenticates in your app, their access token authorizes them to read * their own attribute value for any attribute in this list. An example of this kind of * activity is when your user selects a link to view their profile information. Your app * makes a GetUser API request to retrieve and display your user's profile * data.
*When you don't specify the ReadAttributes for your app client, your
* app can read the values of email_verified,
* phone_number_verified, and the Standard attributes of your user pool.
* When your user pool app client has read access to these default attributes,
* ReadAttributes doesn't return any information. Amazon Cognito only
* populates ReadAttributes in the API response if you have specified your own
* custom set of read attributes.
The list of user attributes that you want your app client to have write access to.
* After your user authenticates in your app, their access token authorizes them to set or
* modify their own attribute value for any attribute in this list. An example of this kind
* of activity is when you present your user with a form to update their profile
* information and they change their last name. Your app then makes an UpdateUserAttributes API request and sets family_name to the
* new value.
When you don't specify the WriteAttributes for your app client, your
* app can write the values of the Standard attributes of your user pool. When your user
* pool has write access to these default attributes, WriteAttributes
* doesn't return any information. Amazon Cognito only populates
* WriteAttributes in the API response if you have specified your own
* custom set of write attributes.
If your app client allows users to sign in through an IdP, this array must include all * attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when * users sign in to your application through an IdP. If your app client does not have write * access to a mapped attribute, Amazon Cognito throws an error when it tries to update the * attribute. For more information, see Specifying IdP Attribute Mappings for Your user * pool.
* @public */ WriteAttributes?: string[] | undefined; /** *The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in * your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and * password, or a custom authentication process that you define with Lambda functions.
*If you don't specify a value for ExplicitAuthFlows, your user client supports ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.
Valid values include:
*
* ALLOW_USER_AUTH: Enable selection-based sign-in
* with USER_AUTH. This setting covers username-password,
* secure remote password (SRP), passwordless, and passkey authentication.
* This authentiation flow can do username-password and SRP authentication
* without other ExplicitAuthFlows permitting them. For example
* users can complete an SRP challenge through USER_AUTH
* without the flow USER_SRP_AUTH being active for the app
* client. This flow doesn't include CUSTOM_AUTH.
*
* ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password
* authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces
* the ADMIN_NO_SRP_AUTH setting. With this authentication flow, your app
* passes a user name and password to Amazon Cognito in the request, instead of using the Secure
* Remote Password (SRP) protocol to securely transmit the password.
* ALLOW_CUSTOM_AUTH: Enable Lambda trigger based
* authentication.
* ALLOW_USER_PASSWORD_AUTH: Enable user password-based
* authentication. In this flow, Amazon Cognito receives the password in the request instead
* of using the SRP protocol to verify passwords.
* ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
* ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh
* tokens.
In some environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or USER_PASSWORD_AUTH.
* You can't assign these legacy ExplicitAuthFlows values to user pool clients at the same time as values that begin with ALLOW_,
* like ALLOW_USER_SRP_AUTH.
A list of provider names for the identity providers (IdPs) that are supported on this
* client. The following are supported: COGNITO, Facebook,
* Google, SignInWithApple, and LoginWithAmazon.
* You can also specify the names that you configured for the SAML and OIDC IdPs in your
* user pool, for example MySAMLIdP or MyOIDCIdP.
This setting applies to providers that you can access with the hosted
* UI and OAuth 2.0 authorization server. The removal of COGNITO
* from this list doesn't prevent authentication operations for local users with the
* user pools API in an Amazon Web Services SDK. The only way to prevent API-based authentication is to
* block access with a WAF rule.
A list of allowed redirect (callback) URLs for the IdPs.
*A redirect URI must:
*Be an absolute URI.
*Be registered with the authorization server.
*Not include a fragment component.
*See OAuth 2.0 - * Redirection Endpoint.
*Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes * only.
*App callback URLs such as myapp://example are also supported.
* @public */ CallbackURLs?: string[] | undefined; /** *A list of allowed logout URLs for the IdPs.
* @public */ LogoutURLs?: string[] | undefined; /** *The default redirect URI. In app clients with one assigned IdP, replaces
* redirect_uri in authentication requests. Must be in the
* CallbackURLs list.
A redirect URI must:
*Be an absolute URI.
*Be registered with the authorization server.
*Not include a fragment component.
*For more information, see Default redirect URI.
*Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes * only.
*App callback URLs such as myapp://example are also supported.
* @public */ DefaultRedirectURI?: string | undefined; /** *The OAuth grant types that you want your app client to generate. To create an app
* client that generates client credentials grants, you must add
* client_credentials as the only allowed OAuth flow.
Use a code grant flow, which provides an authorization code as the
* response. This code can be exchanged for access tokens with the
* /oauth2/token endpoint.
Issue the access token (and, optionally, ID token, based on scopes) * directly to your user.
*Issue the access token from the /oauth2/token endpoint
* directly to a non-person user using a combination of the client ID and
* client secret.
The allowed OAuth scopes. Possible values provided by OAuth are phone,
* email, openid, and profile. Possible values
* provided by Amazon Web Services are aws.cognito.signin.user.admin. Custom
* scopes created in Resource Servers are also supported.
Set to true to use OAuth 2.0 features in your user pool app client.
* AllowedOAuthFlowsUserPoolClient must be true before you can configure
* the following features in your app client.
* CallBackURLs: Callback URLs.
* LogoutURLs: Sign-out redirect URLs.
* AllowedOAuthScopes: OAuth 2.0 scopes.
* AllowedOAuthFlows: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.
To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set
* AllowedOAuthFlowsUserPoolClient to true in a CreateUserPoolClient or
* UpdateUserPoolClient API request. If you don't set a value for
* AllowedOAuthFlowsUserPoolClient in a request with the CLI or SDKs, it defaults
* to false.
The user pool analytics configuration for collecting metrics and sending them to your * Amazon Pinpoint campaign.
*In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending * events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is * available, user pools support sending events to Amazon Pinpoint projects within that same * Region.
*Errors and responses that you want Amazon Cognito APIs to return during authentication, account
* confirmation, and password recovery when the user doesn't exist in the user pool. When
* set to ENABLED and the user doesn't exist, authentication returns an error
* indicating either the username or password was incorrect. Account confirmation and
* password recovery return a response indicating a code was sent to a simulated
* destination. When set to LEGACY, those APIs return a
* UserNotFoundException exception if the user doesn't exist in the user
* pool.
Valid values include:
*
* ENABLED - This prevents user existence-related errors.
* LEGACY - This represents the early behavior of Amazon Cognito where user
* existence related errors aren't prevented.
Defaults to LEGACY when you don't provide a value.
Activates or deactivates token revocation. For more information about revoking tokens, * see RevokeToken.
*If you don't include this parameter, token revocation is automatically activated for * the new user pool client.
* @public */ EnableTokenRevocation?: boolean | undefined; /** *Activates the propagation of additional user context data. For more information about
* propagation of user context data, see Adding advanced security to a user pool. If you don’t include this
* parameter, you can't send device fingerprint information, including source IP address,
* to Amazon Cognito advanced security. You can only activate
* EnablePropagateAdditionalUserContextData in an app client that has a
* client secret.
Amazon Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity is the duration,
* in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.
The configuration of a user pool client.
*This data type is a request parameter of CreateUserPoolClient and UpdateUserPoolClient, and a response parameter of * DescribeUserPoolClient.
* @public */ export interface UserPoolClientType { /** *The ID of the user pool associated with the app client.
* @public */ UserPoolId?: string | undefined; /** *The name of the app client.
* @public */ ClientName?: string | undefined; /** *The ID of the app client.
* @public */ ClientId?: string | undefined; /** *The app client secret.
* @public */ ClientSecret?: string | undefined; /** *The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
* human-readable format like ISO 8601 or a Java Date object.
The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
* human-readable format like ISO 8601 or a Java Date object.
The refresh token time limit. After this limit expires, your user can't use
* their refresh token. To specify the time unit for RefreshTokenValidity as
* seconds, minutes, hours, or days,
* set a TokenValidityUnits value in your API request.
For example, when you set RefreshTokenValidity as 10 and
* TokenValidityUnits as days, your user can refresh their session
* and retrieve new access and ID tokens for 10 days.
The default time unit for RefreshTokenValidity in an API request is days.
* You can't set RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the
* value with the default value of 30 days. Valid range is displayed below
* in seconds.
If you don't specify otherwise in the configuration of your app client, your refresh * tokens are valid for 30 days.
* @public */ RefreshTokenValidity?: number | undefined; /** *The access token time limit. After this limit expires, your user can't use
* their access token. To specify the time unit for AccessTokenValidity as
* seconds, minutes, hours, or days,
* set a TokenValidityUnits value in your API request.
For example, when you set AccessTokenValidity to 10 and
* TokenValidityUnits to hours, your user can authorize access with
* their access token for 10 hours.
The default time unit for AccessTokenValidity in an API request is hours.
* Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your access * tokens are valid for one hour.
* @public */ AccessTokenValidity?: number | undefined; /** *The ID token time limit. After this limit expires, your user can't use
* their ID token. To specify the time unit for IdTokenValidity as
* seconds, minutes, hours, or days,
* set a TokenValidityUnits value in your API request.
For example, when you set IdTokenValidity as 10 and
* TokenValidityUnits as hours, your user can authenticate their
* session with their ID token for 10 hours.
The default time unit for IdTokenValidity in an API request is hours.
* Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your ID * tokens are valid for one hour.
* @public */ IdTokenValidity?: number | undefined; /** *The time units that, with IdTokenValidity,
* AccessTokenValidity, and RefreshTokenValidity, set and
* display the duration of ID, access, and refresh tokens for an app client. You can assign
* a separate token validity unit to each type of token.
The list of user attributes that you want your app client to have read access to. * After your user authenticates in your app, their access token authorizes them to read * their own attribute value for any attribute in this list. An example of this kind of * activity is when your user selects a link to view their profile information. Your app * makes a GetUser API request to retrieve and display your user's profile * data.
*When you don't specify the ReadAttributes for your app client, your
* app can read the values of email_verified,
* phone_number_verified, and the Standard attributes of your user pool.
* When your user pool app client has read access to these default attributes,
* ReadAttributes doesn't return any information. Amazon Cognito only
* populates ReadAttributes in the API response if you have specified your own
* custom set of read attributes.
The list of user attributes that you want your app client to have write access to.
* After your user authenticates in your app, their access token authorizes them to set or
* modify their own attribute value for any attribute in this list. An example of this kind
* of activity is when you present your user with a form to update their profile
* information and they change their last name. Your app then makes an UpdateUserAttributes API request and sets family_name to the
* new value.
When you don't specify the WriteAttributes for your app client, your
* app can write the values of the Standard attributes of your user pool. When your user
* pool has write access to these default attributes, WriteAttributes
* doesn't return any information. Amazon Cognito only populates
* WriteAttributes in the API response if you have specified your own
* custom set of write attributes.
If your app client allows users to sign in through an IdP, this array must include all * attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when * users sign in to your application through an IdP. If your app client does not have write * access to a mapped attribute, Amazon Cognito throws an error when it tries to update the * attribute. For more information, see Specifying IdP Attribute Mappings for Your user * pool.
* @public */ WriteAttributes?: string[] | undefined; /** *The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in * your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and * password, or a custom authentication process that you define with Lambda functions.
*If you don't specify a value for ExplicitAuthFlows, your user client supports ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.
Valid values include:
*
* ALLOW_USER_AUTH: Enable selection-based sign-in
* with USER_AUTH. This setting covers username-password,
* secure remote password (SRP), passwordless, and passkey authentication.
* This authentiation flow can do username-password and SRP authentication
* without other ExplicitAuthFlows permitting them. For example
* users can complete an SRP challenge through USER_AUTH
* without the flow USER_SRP_AUTH being active for the app
* client. This flow doesn't include CUSTOM_AUTH.
*
* ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password
* authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces
* the ADMIN_NO_SRP_AUTH setting. With this authentication flow, your app
* passes a user name and password to Amazon Cognito in the request, instead of using the Secure
* Remote Password (SRP) protocol to securely transmit the password.
* ALLOW_CUSTOM_AUTH: Enable Lambda trigger based
* authentication.
* ALLOW_USER_PASSWORD_AUTH: Enable user password-based
* authentication. In this flow, Amazon Cognito receives the password in the request instead
* of using the SRP protocol to verify passwords.
* ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
* ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh
* tokens.
In some environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or USER_PASSWORD_AUTH.
* You can't assign these legacy ExplicitAuthFlows values to user pool clients at the same time as values that begin with ALLOW_,
* like ALLOW_USER_SRP_AUTH.
A list of provider names for the identity providers (IdPs) that are supported on this
* client. The following are supported: COGNITO, Facebook,
* Google, SignInWithApple, and LoginWithAmazon.
* You can also specify the names that you configured for the SAML and OIDC IdPs in your
* user pool, for example MySAMLIdP or MyOIDCIdP.
This setting applies to providers that you can access with the hosted
* UI and OAuth 2.0 authorization server. The removal of COGNITO
* from this list doesn't prevent authentication operations for local users with the
* user pools API in an Amazon Web Services SDK. The only way to prevent API-based authentication is to
* block access with a WAF rule.
A list of allowed redirect (callback) URLs for the IdPs.
*A redirect URI must:
*Be an absolute URI.
*Be registered with the authorization server.
*Not include a fragment component.
*See OAuth 2.0 - * Redirection Endpoint.
*Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes * only.
*App callback URLs such as myapp://example are also supported.
* @public */ CallbackURLs?: string[] | undefined; /** *A list of allowed logout URLs for the IdPs.
* @public */ LogoutURLs?: string[] | undefined; /** *The default redirect URI. Must be in the CallbackURLs list.
A redirect URI must:
*Be an absolute URI.
*Be registered with the authorization server.
*Not include a fragment component.
*See OAuth 2.0 - * Redirection Endpoint.
*Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes * only.
*App callback URLs such as myapp://example are also supported.
* @public */ DefaultRedirectURI?: string | undefined; /** *The OAuth grant types that you want your app client to generate. To create an app
* client that generates client credentials grants, you must add
* client_credentials as the only allowed OAuth flow.
Use a code grant flow, which provides an authorization code as the
* response. This code can be exchanged for access tokens with the
* /oauth2/token endpoint.
Issue the access token (and, optionally, ID token, based on scopes) * directly to your user.
*Issue the access token from the /oauth2/token endpoint
* directly to a non-person user using a combination of the client ID and
* client secret.
The OAuth 2.0 scopes that you want your app client to support. Can include standard
* OAuth scopes like phone, email, openid, and
* profile. Can also include the
* aws.cognito.signin.user.admin scope that authorizes user profile
* self-service operations and custom scopes from resource servers.
Set to true to use OAuth 2.0 features in your user pool app client.
* AllowedOAuthFlowsUserPoolClient must be true before you can configure
* the following features in your app client.
* CallBackURLs: Callback URLs.
* LogoutURLs: Sign-out redirect URLs.
* AllowedOAuthScopes: OAuth 2.0 scopes.
* AllowedOAuthFlows: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.
To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set
* AllowedOAuthFlowsUserPoolClient to true in a CreateUserPoolClient or
* UpdateUserPoolClient API request. If you don't set a value for
* AllowedOAuthFlowsUserPoolClient in a request with the CLI or SDKs, it defaults
* to false.
The user pool analytics configuration for collecting metrics and sending them to your * Amazon Pinpoint campaign.
*In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending * events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is * available, user pools support sending events to Amazon Pinpoint projects within that same * Region.
*Errors and responses that you want Amazon Cognito APIs to return during authentication, account
* confirmation, and password recovery when the user doesn't exist in the user pool. When
* set to ENABLED and the user doesn't exist, authentication returns an error
* indicating either the username or password was incorrect. Account confirmation and
* password recovery return a response indicating a code was sent to a simulated
* destination. When set to LEGACY, those APIs return a
* UserNotFoundException exception if the user doesn't exist in the user
* pool.
Valid values include:
*
* ENABLED - This prevents user existence-related errors.
* LEGACY - This represents the early behavior of Amazon Cognito where user
* existence related errors aren't prevented.
Defaults to LEGACY when you don't provide a value.
Indicates whether token revocation is activated for the user pool client. When you * create a new user pool client, token revocation is activated by default. For more * information about revoking tokens, see RevokeToken.
* @public */ EnableTokenRevocation?: boolean | undefined; /** *When EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts an
* IpAddress value that you send in the UserContextData
* parameter. The UserContextData parameter sends information to Amazon Cognito
* advanced security for risk analysis. You can send UserContextData when you
* sign in Amazon Cognito native users with the InitiateAuth and
* RespondToAuthChallenge API operations.
When EnablePropagateAdditionalUserContextData is false, you can't send
* your user's source IP address to Amazon Cognito advanced security with unauthenticated API
* operations. EnablePropagateAdditionalUserContextData doesn't affect whether
* you can send a source IP address in a ContextData parameter with the
* authenticated API operations AdminInitiateAuth and
* AdminRespondToAuthChallenge.
You can only activate EnablePropagateAdditionalUserContextData in an app
* client that has a client secret. For more information about propagation of user context
* data, see Adding user device and session data to API requests.
Amazon Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity is the duration,
* in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.
Represents the response from the server to create a user pool client.
* @public */ export interface CreateUserPoolClientResponse { /** *The user pool client that was just created.
* @public */ UserPoolClient?: UserPoolClientType | undefined; } /** *This exception is thrown when the specified OAuth flow is not valid.
* @public */ export declare class InvalidOAuthFlowException extends __BaseException { readonly name: "InvalidOAuthFlowException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThis exception is thrown when the specified scope doesn't exist.
* @public */ export declare class ScopeDoesNotExistException extends __BaseException { readonly name: "ScopeDoesNotExistException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe configuration for a hosted UI custom domain.
*This data type is a request parameter of CreateUserPoolDomain and UpdateUserPoolDomain.
* @public */ export interface CustomDomainConfigType { /** *The Amazon Resource Name (ARN) of an Certificate Manager SSL certificate. You use * this certificate for the subdomain of your custom domain.
* @public */ CertificateArn: string | undefined; } /** * @public */ export interface CreateUserPoolDomainRequest { /** *The domain string. For custom domains, this is the fully-qualified domain name, such
* as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone,
* such as auth.
The ID of the user pool where you want to add a domain.
* @public */ UserPoolId: string | undefined; /** *The version of managed login branding that you want to apply to your domain. A value
* of 1 indicates hosted UI (classic) branding and a version of 2
* indicates managed login branding.
Managed login requires that your user pool be configured for any feature plan other than Lite.
The configuration for a custom domain that hosts the sign-up and sign-in webpages for * your application.
*Provide this parameter only if you want to use a custom domain for your user pool. * Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain * instead.
*For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.
* @public */ CustomDomainConfig?: CustomDomainConfigType | undefined; } /** * @public */ export interface CreateUserPoolDomainResponse { /** *The version of managed login branding applied your domain. A value of 1
* indicates hosted UI (classic) branding and a version of 2 indicates managed
* login branding.
The Amazon CloudFront endpoint that you use as the target of the alias that you set up with
* your Domain Name Service (DNS) provider. Amazon Cognito returns this value if you set a custom
* domain with CustomDomainConfig. If you set an Amazon Cognito prefix domain, this
* operation returns a blank response.
The name of the group.
* @public */ GroupName: string | undefined; /** *The user pool ID for the user pool.
* @public */ UserPoolId: string | undefined; } /** * @public */ export interface DeleteIdentityProviderRequest { /** *The user pool ID.
* @public */ UserPoolId: string | undefined; /** *The IdP name.
* @public */ ProviderName: string | undefined; } /** *This exception is thrown when the specified identifier isn't supported.
* @public */ export declare class UnsupportedIdentityProviderException extends __BaseException { readonly name: "UnsupportedIdentityProviderException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe ID of the managed login branding style that you want to delete.
* @public */ ManagedLoginBrandingId: string | undefined; /** *The ID of the user pool that contains the managed login branding style that you want * to delete.
* @public */ UserPoolId: string | undefined; } /** * @public */ export interface DeleteResourceServerRequest { /** *The user pool ID for the user pool that hosts the resource server.
* @public */ UserPoolId: string | undefined; /** *The identifier for the resource server.
* @public */ Identifier: string | undefined; } /** *Represents the request to delete a user.
* @public */ export interface DeleteUserRequest { /** *A valid access token that Amazon Cognito issued to the user whose user profile you want to * delete.
* @public */ AccessToken: string | undefined; } /** *Represents the request to delete user attributes.
* @public */ export interface DeleteUserAttributesRequest { /** *An array of strings representing the user attribute names you want to delete.
*For custom attributes, you must prependattach the custom: prefix to the
* front of the attribute name.
A valid access token that Amazon Cognito issued to the user whose attributes you want to * delete.
* @public */ AccessToken: string | undefined; } /** *Represents the response from the server to delete user attributes.
* @public */ export interface DeleteUserAttributesResponse { } /** *Represents the request to delete a user pool.
* @public */ export interface DeleteUserPoolRequest { /** *The user pool ID for the user pool you want to delete.
* @public */ UserPoolId: string | undefined; } /** *Represents the request to delete a user pool client.
* @public */ export interface DeleteUserPoolClientRequest { /** *The user pool ID for the user pool where you want to delete the client.
* @public */ UserPoolId: string | undefined; /** *The app client ID of the app associated with the user pool.
* @public */ ClientId: string | undefined; } /** * @public */ export interface DeleteUserPoolDomainRequest { /** *The domain string. For custom domains, this is the fully-qualified domain name, such
* as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone,
* such as auth.
The user pool ID.
* @public */ UserPoolId: string | undefined; } /** * @public */ export interface DeleteUserPoolDomainResponse { } /** * @public */ export interface DeleteWebAuthnCredentialRequest { /** *A valid access token that Amazon Cognito issued to the user whose passkey you want to * delete.
* @public */ AccessToken: string | undefined; /** *The unique identifier of the passkey that you want to delete. Look up registered * devices with ListWebAuthnCredentials.
* @public */ CredentialId: string | undefined; } /** * @public */ export interface DeleteWebAuthnCredentialResponse { } /** * @public */ export interface DescribeIdentityProviderRequest { /** *The user pool ID.
* @public */ UserPoolId: string | undefined; /** *The IdP name.
* @public */ ProviderName: string | undefined; } /** * @public */ export interface DescribeIdentityProviderResponse { /** *The identity provider details.
* @public */ IdentityProvider: IdentityProviderType | undefined; } /** * @public */ export interface DescribeManagedLoginBrandingRequest { /** *The ID of the user pool that contains the managed login branding style that you want * to get information about.
* @public */ UserPoolId: string | undefined; /** *The ID of the managed login branding style that you want to get more information * about.
* @public */ ManagedLoginBrandingId: string | undefined; /** *When true, returns values for branding options that are unchanged from
* Amazon Cognito defaults. When false or when you omit this parameter, returns only
* values that you customized in your branding style.
The details of the requested branding style.
* @public */ ManagedLoginBranding?: ManagedLoginBrandingType | undefined; } /** * @public */ export interface DescribeManagedLoginBrandingByClientRequest { /** *The ID of the user pool that contains the app client where you want more information * about the managed login branding style.
* @public */ UserPoolId: string | undefined; /** *The app client that's assigned to the branding style that you want more information * about.
* @public */ ClientId: string | undefined; /** *When true, returns values for branding options that are unchanged from
* Amazon Cognito defaults. When false or when you omit this parameter, returns only
* values that you customized in your branding style.
The details of the requested branding style.
* @public */ ManagedLoginBranding?: ManagedLoginBrandingType | undefined; } /** * @public */ export interface DescribeResourceServerRequest { /** *The user pool ID for the user pool that hosts the resource server.
* @public */ UserPoolId: string | undefined; /** *A unique resource server identifier for the resource server. The identifier can be an
* API friendly name like solar-system-data. You can also set an API URL like
* https://solar-system-data-api.example.com as your identifier.
Amazon Cognito represents scopes in the access token in the format
* $resource-server-identifier/$scope. Longer scope-identifier strings
* increase the size of your access tokens.
The resource server.
* @public */ ResourceServer: ResourceServerType | undefined; } /** * @public */ export interface DescribeRiskConfigurationRequest { /** *The user pool ID.
* @public */ UserPoolId: string | undefined; /** *The app client ID.
* @public */ ClientId?: string | undefined; } /** * @public * @enum */ export declare const CompromisedCredentialsEventActionType: { readonly BLOCK: "BLOCK"; readonly NO_ACTION: "NO_ACTION"; }; /** * @public */ export type CompromisedCredentialsEventActionType = (typeof CompromisedCredentialsEventActionType)[keyof typeof CompromisedCredentialsEventActionType]; /** *Settings for user pool actions when Amazon Cognito detects compromised credentials with
* advanced security features in full-function ENFORCED mode.
This data type is a request parameter of SetRiskConfiguration and a response parameter of DescribeRiskConfiguration.
* @public */ export interface CompromisedCredentialsActionsType { /** *The action that Amazon Cognito takes when it detects compromised credentials.
* @public */ EventAction: CompromisedCredentialsEventActionType | undefined; } /** * @public * @enum */ export declare const EventFilterType: { readonly PASSWORD_CHANGE: "PASSWORD_CHANGE"; readonly SIGN_IN: "SIGN_IN"; readonly SIGN_UP: "SIGN_UP"; }; /** * @public */ export type EventFilterType = (typeof EventFilterType)[keyof typeof EventFilterType]; /** *Settings for compromised-credentials actions and authentication-event sources with
* advanced security features in full-function ENFORCED mode.
This data type is a request parameter of SetRiskConfiguration and a response parameter of DescribeRiskConfiguration.
* @public */ export interface CompromisedCredentialsRiskConfigurationType { /** *Settings for the sign-in activity where you want to configure compromised-credentials * actions. Defaults to all events.
* @public */ EventFilter?: EventFilterType[] | undefined; /** *Settings for the actions that you want your user pool to take when Amazon Cognito detects * compromised credentials.
* @public */ Actions: CompromisedCredentialsActionsType | undefined; } /** *Exceptions to the risk evaluation configuration, including always-allow and * always-block IP address ranges.
*This data type is a request parameter of SetRiskConfiguration and a response parameter of DescribeRiskConfiguration.
* @public */ export interface RiskExceptionConfigurationType { /** *An always-block IP address list. Overrides the risk decision and always blocks * authentication requests. This parameter is displayed and set in CIDR notation.
* @public */ BlockedIPRangeList?: string[] | undefined; /** *An always-allow IP address list. Risk detection isn't performed on the IP addresses in * this range list. This parameter is displayed and set in CIDR notation.
* @public */ SkippedIPRangeList?: string[] | undefined; } /** *The settings of risk configuration for threat protection with advanced security * features in a user pool.
*This data type is a response parameter of DescribeRiskConfiguration and SetRiskConfiguration.
* @public */ export interface RiskConfigurationType { /** *The ID of the user pool that has the risk configuration applied.
* @public */ UserPoolId?: string | undefined; /** *The app client where this configuration is applied. When this parameter isn't present, * the risk configuration applies to all user pool app clients that don't have * client-level settings.
* @public */ ClientId?: string | undefined; /** *Settings for compromised-credentials actions and authentication types with advanced
* security features in full-function ENFORCED mode.
The settings for automated responses and notification templates for adaptive * authentication with advanced security features.
* @public */ AccountTakeoverRiskConfiguration?: AccountTakeoverRiskConfigurationType | undefined; /** *Exceptions to the risk evaluation configuration, including always-allow and * always-block IP address ranges.
* @public */ RiskExceptionConfiguration?: RiskExceptionConfigurationType | undefined; /** *The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
* human-readable format like ISO 8601 or a Java Date object.
The risk configuration.
* @public */ RiskConfiguration: RiskConfigurationType | undefined; } /** *Represents the request to describe the user import job.
* @public */ export interface DescribeUserImportJobRequest { /** *The user pool ID for the user pool that the users are being imported into.
* @public */ UserPoolId: string | undefined; /** *The job ID for the user import job.
* @public */ JobId: string | undefined; } /** *Represents the response from the server to the request to describe the user import * job.
* @public */ export interface DescribeUserImportJobResponse { /** *The job object that represents the user import job.
* @public */ UserImportJob?: UserImportJobType | undefined; } /** *Represents the request to describe the user pool.
* @public */ export interface DescribeUserPoolRequest { /** *The user pool ID for the user pool you want to describe.
* @public */ UserPoolId: string | undefined; } /** *Represents the response to describe the user pool.
* @public */ export interface DescribeUserPoolResponse { /** *The container of metadata returned by the server to describe the pool.
* @public */ UserPool?: UserPoolType | undefined; } /** *Represents the request to describe a user pool client.
* @public */ export interface DescribeUserPoolClientRequest { /** *The user pool ID for the user pool you want to describe.
* @public */ UserPoolId: string | undefined; /** *The app client ID of the app associated with the user pool.
* @public */ ClientId: string | undefined; } /** *Represents the response from the server from a request to describe the user pool * client.
* @public */ export interface DescribeUserPoolClientResponse { /** *The user pool client from a server response to describe the user pool client.
* @public */ UserPoolClient?: UserPoolClientType | undefined; } /** * @public */ export interface DescribeUserPoolDomainRequest { /** *The domain string. For custom domains, this is the fully-qualified domain name, such
* as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone,
* such as auth.
A container for information about the user pool domain associated with the hosted UI * and OAuth endpoints.
*This data type is a response parameter of DescribeUserPoolDomain.
* @public */ export interface DomainDescriptionType { /** *The ID of the user pool that the domain is attached to.
* @public */ UserPoolId?: string | undefined; /** *The Amazon Web Services account that you created the user pool in.
* @public */ AWSAccountId?: string | undefined; /** *The domain string. For custom domains, this is the fully-qualified domain name, such
* as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone,
* such as auth.
The Amazon S3 bucket where the static files for this domain are stored.
* @public */ S3Bucket?: string | undefined; /** *The Amazon CloudFront endpoint that hosts your custom domain.
* @public */ CloudFrontDistribution?: string | undefined; /** *The app version.
* @public */ Version?: string | undefined; /** *The domain status.
* @public */ Status?: DomainStatusType | undefined; /** *The configuration for a custom domain that hosts the sign-up and sign-in webpages for * your application.
* @public */ CustomDomainConfig?: CustomDomainConfigType | undefined; /** *The version of managed login branding that you want to apply to your domain. A value
* of 1 indicates hosted UI (classic) branding and a version of 2
* indicates managed login branding.
Managed login requires that your user pool be configured for any feature plan other than Lite.
A domain description object containing information about the domain.
* @public */ DomainDescription?: DomainDescriptionType | undefined; } /** *Represents the request to forget the device.
* @public */ export interface ForgetDeviceRequest { /** *A valid access token that Amazon Cognito issued to the user whose registered device you want to * forget.
* @public */ AccessToken?: string | undefined; /** *The device key.
* @public */ DeviceKey: string | undefined; } /** *Represents the request to reset a user's password.
* @public */ export interface ForgotPasswordRequest { /** *The ID of the client associated with the user pool.
* @public */ ClientId: string | undefined; /** *A keyed-hash message authentication code (HMAC) calculated using the secret key of a * user pool client and username plus the client ID in the message.
* @public */ SecretHash?: string | undefined; /** *Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito * when it makes API requests.
* @public */ UserContextData?: UserContextDataType | undefined; /** *The username of the user that you want to query or modify. The value of this parameter
* is typically your user's username, but it can be any of their alias attributes. If
* username isn't an alias attribute in your user pool, this value
* must be the sub of a local user or the username of a user from a
* third-party IdP.
The Amazon Pinpoint analytics metadata that contributes to your metrics for
* ForgotPassword calls.
A map of custom key-value pairs that you can provide as input for any custom workflows * that this action triggers.
*You create custom workflows by assigning Lambda functions to user pool
* triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any
* functions that are assigned to the following triggers: pre sign-up,
* custom message, and user migration. When
* Amazon Cognito invokes any of these functions, it passes a JSON payload, which the
* function receives as input. This payload contains a clientMetadata
* attribute, which provides the data that you assigned to the ClientMetadata parameter in
* your ForgotPassword request. In your function code in Lambda, you can
* process the clientMetadata value to enhance your workflow for your specific
* needs.
For more information, see * Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
*When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the * following:
*Store the ClientMetadata value. This data is available only to Lambda * triggers that are assigned to a user pool to support custom workflows. If * your user pool configuration doesn't include triggers, the ClientMetadata * parameter serves no purpose.
*Validate the ClientMetadata value.
*Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive * information.
*The delivery details for an email or SMS message that Amazon Cognito sent for authentication or * verification.
*This data type is a response parameter of operations that send a code for user profile * confirmation, verification, or management, for example ForgotPassword and SignUp.
* @public */ export interface CodeDeliveryDetailsType { /** *The email address or phone number destination where Amazon Cognito sent the code.
* @public */ Destination?: string | undefined; /** *The method that Amazon Cognito used to send the code.
* @public */ DeliveryMedium?: DeliveryMediumType | undefined; /** *The name of the attribute that Amazon Cognito verifies with the code.
* @public */ AttributeName?: string | undefined; } /** *The response from Amazon Cognito to a request to reset a password.
* @public */ export interface ForgotPasswordResponse { /** *The code delivery details returned by the server in response to the request to reset a * password.
* @public */ CodeDeliveryDetails?: CodeDeliveryDetailsType | undefined; } /** *Represents the request to get the header information of the CSV file for the user * import job.
* @public */ export interface GetCSVHeaderRequest { /** *The user pool ID for the user pool that the users are to be imported into.
* @public */ UserPoolId: string | undefined; } /** *Represents the response from the server to the request to get the header information * of the CSV file for the user import job.
* @public */ export interface GetCSVHeaderResponse { /** *The user pool ID for the user pool that the users are to be imported into.
* @public */ UserPoolId?: string | undefined; /** *The header information of the CSV file for the user import job.
* @public */ CSVHeader?: string[] | undefined; } /** *Represents the request to get the device.
* @public */ export interface GetDeviceRequest { /** *The device key.
* @public */ DeviceKey: string | undefined; /** *A valid access token that Amazon Cognito issued to the user whose device information you want * to request.
* @public */ AccessToken?: string | undefined; } /** *Gets the device response.
* @public */ export interface GetDeviceResponse { /** *The device.
* @public */ Device: DeviceType | undefined; } /** * @public */ export interface GetGroupRequest { /** *The name of the group.
* @public */ GroupName: string | undefined; /** *The user pool ID for the user pool.
* @public */ UserPoolId: string | undefined; } /** * @public */ export interface GetGroupResponse { /** *The group object for the group.
* @public */ Group?: GroupType | undefined; } /** * @public */ export interface GetIdentityProviderByIdentifierRequest { /** *The user pool ID.
* @public */ UserPoolId: string | undefined; /** *The IdP identifier.
* @public */ IdpIdentifier: string | undefined; } /** * @public */ export interface GetIdentityProviderByIdentifierResponse { /** *The identity provider details.
* @public */ IdentityProvider: IdentityProviderType | undefined; } /** * @public */ export interface GetLogDeliveryConfigurationRequest { /** *The ID of the user pool that has the logging configuration that you want to * view.
* @public */ UserPoolId: string | undefined; } /** *Configuration for the CloudWatch log group destination of user pool detailed activity * logging, or of user activity log export with advanced security features.
*This data type is a request parameter of SetLogDeliveryConfiguration and a response parameter of * GetLogDeliveryConfiguration.
* @public */ export interface CloudWatchLogsConfigurationType { /** *The Amazon Resource Name (arn) of a CloudWatch Logs log group where your user pool sends logs. * The log group must not be encrypted with Key Management Service and must be in the same Amazon Web Services account * as your user pool.
*To send logs to log groups with a resource policy of a size greater than 5120
* characters, configure a log group with a path that starts with
* /aws/vendedlogs. For more information, see Enabling
* logging from certain Amazon Web Services services.
Configuration for the Amazon Data Firehose stream destination of user activity log export with * advanced security features.
* @public */ export interface FirehoseConfigurationType { /** *The ARN of an Amazon Data Firehose stream that's the destination for advanced security * features log export.
* @public */ StreamArn?: string | undefined; } /** * @public * @enum */ export declare const LogLevel: { readonly ERROR: "ERROR"; readonly INFO: "INFO"; }; /** * @public */ export type LogLevel = (typeof LogLevel)[keyof typeof LogLevel]; /** *Configuration for the Amazon S3 bucket destination of user activity log export with * advanced security features.
* @public */ export interface S3ConfigurationType { /** *The ARN of an Amazon S3 bucket that's the destination for advanced security features * log export.
* @public */ BucketArn?: string | undefined; } /** *The configuration of user event logs to an external Amazon Web Services service like * Amazon Data Firehose, Amazon S3, or Amazon CloudWatch Logs.
*This data type is a request parameter of SetLogDeliveryConfiguration and a response parameter of * GetLogDeliveryConfiguration.
* @public */ export interface LogConfigurationType { /** *The errorlevel selection of logs that a user pool sends for detailed
* activity logging. To send userNotification activity with information about message delivery, choose ERROR with
* CloudWatchLogsConfiguration. To send userAuthEvents
* activity with user logs from advanced security features, choose INFO with
* one of CloudWatchLogsConfiguration, FirehoseConfiguration, or
* S3Configuration.
The source of events that your user pool sends for logging. To send error-level logs
* about user notification activity, set to userNotification. To send
* info-level logs about advanced security features user activity, set to
* userAuthEvents.
The CloudWatch log group destination of user pool detailed activity logs, or of user * activity log export with advanced security features.
* @public */ CloudWatchLogsConfiguration?: CloudWatchLogsConfigurationType | undefined; /** *The Amazon S3 bucket destination of user activity log export with advanced security * features. To activate this setting, * advanced security features must be active in your user pool.
* @public */ S3Configuration?: S3ConfigurationType | undefined; /** *The Amazon Data Firehose stream destination of user activity log export with advanced security * features. To activate this setting, * advanced security features must be active in your user pool.
* @public */ FirehoseConfiguration?: FirehoseConfigurationType | undefined; } /** *The logging parameters of a user pool, as returned in the response to a GetLogDeliveryConfiguration request.
* @public */ export interface LogDeliveryConfigurationType { /** *The ID of the user pool where you configured logging.
* @public */ UserPoolId: string | undefined; /** *A logging destination of a user pool. User pools can have multiple logging * destinations for message-delivery and user-activity logs.
* @public */ LogConfigurations: LogConfigurationType[] | undefined; } /** * @public */ export interface GetLogDeliveryConfigurationResponse { /** *The logging configuration of the requested user pool.
* @public */ LogDeliveryConfiguration?: LogDeliveryConfigurationType | undefined; } /** *Request to get a signing certificate from Amazon Cognito.
* @public */ export interface GetSigningCertificateRequest { /** *The user pool ID.
* @public */ UserPoolId: string | undefined; } /** *Response from Amazon Cognito for a signing certificate request.
* @public */ export interface GetSigningCertificateResponse { /** *The signing certificate.
* @public */ Certificate?: string | undefined; } /** * @public */ export interface GetUICustomizationRequest { /** *The user pool ID for the user pool.
* @public */ UserPoolId: string | undefined; /** *The client ID for the client app.
* @public */ ClientId?: string | undefined; } /** *A container for the UI customization information for the hosted UI in a user * pool.
*This data type is a response parameter of GetUICustomization.
* @public */ export interface UICustomizationType { /** *The ID of the user pool with hosted UI customizations.
* @public */ UserPoolId?: string | undefined; /** *The app client ID for your UI customization. When this value isn't present, the * customization applies to all user pool app clients that don't have client-level * settings..
* @public */ ClientId?: string | undefined; /** *A URL path to the hosted logo image of your UI customization.
* @public */ ImageUrl?: string | undefined; /** *The CSS values in the UI customization. To get a template with your UI customization * options, make a GetUiCustomization request.
* @public */ CSS?: string | undefined; /** *The CSS version number.
* @public */ CSSVersion?: string | undefined; /** *The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
* human-readable format like ISO 8601 or a Java Date object.
The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
* human-readable format like ISO 8601 or a Java Date object.
The UI customization information.
* @public */ UICustomization: UICustomizationType | undefined; } /** *Represents the request to get information about the user.
* @public */ export interface GetUserRequest { /** *A non-expired access token for the user whose information you want to query.
* @public */ AccessToken: string | undefined; } /** *Represents the response from the server from the request to get information about the * user.
* @public */ export interface GetUserResponse { /** *The username of the user that you requested.
* @public */ Username: string | undefined; /** *An array of name-value pairs representing user attributes.
*For custom attributes, you must prepend the custom: prefix to the
* attribute name.
* This response parameter is no longer supported. It provides * information only about SMS MFA configurations. It doesn't provide information about * time-based one-time password (TOTP) software token MFA configurations. To look up * information about either type of MFA configuration, use UserMFASettingList * instead.
* @public */ MFAOptions?: MFAOptionType[] | undefined; /** *The user's preferred MFA setting.
* @public */ PreferredMfaSetting?: string | undefined; /** *The MFA options that are activated for the user. The possible values in this list are
* SMS_MFA, EMAIL_OTP, and
* SOFTWARE_TOKEN_MFA.
Represents the request to get user attribute verification.
* @public */ export interface GetUserAttributeVerificationCodeRequest { /** *A non-expired access token for the user whose attribute verification code you want to * generate.
* @public */ AccessToken: string | undefined; /** *The attribute name returned by the server response to get the user attribute * verification code.
* @public */ AttributeName: string | undefined; /** *A map of custom key-value pairs that you can provide as input for any custom workflows * that this action triggers.
*You create custom workflows by assigning Lambda functions to user pool
* triggers. When you use the GetUserAttributeVerificationCode API action, Amazon Cognito invokes
* the function that is assigned to the custom message trigger. When
* Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as
* input. This payload contains a clientMetadata attribute, which provides the
* data that you assigned to the ClientMetadata parameter in your
* GetUserAttributeVerificationCode request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for
* your specific needs.
For more information, see * Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
*When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the * following:
*Store the ClientMetadata value. This data is available only to Lambda * triggers that are assigned to a user pool to support custom workflows. If * your user pool configuration doesn't include triggers, the ClientMetadata * parameter serves no purpose.
*Validate the ClientMetadata value.
*Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive * information.
*The verification code response returned by the server response to get the user * attribute verification code.
* @public */ export interface GetUserAttributeVerificationCodeResponse { /** *The code delivery details returned by the server in response to the request to get the * user attribute verification code.
* @public */ CodeDeliveryDetails?: CodeDeliveryDetailsType | undefined; } /** * @public */ export interface GetUserAuthFactorsRequest { /** *A valid access token that Amazon Cognito issued to the user whose authentication factors you * want to view.
* @public */ AccessToken: string | undefined; } /** * @public */ export interface GetUserAuthFactorsResponse { /** *The username of the currently sign-in user.
* @public */ Username: string | undefined; /** *The user's preferred MFA setting.
* @public */ PreferredMfaSetting?: string | undefined; /** *The MFA options that are activated for the user. The possible values in this list are
* SMS_MFA, EMAIL_OTP, and
* SOFTWARE_TOKEN_MFA.
The authentication types that are available to the user with USER_AUTH
* sign-in.
The user pool ID.
* @public */ UserPoolId: string | undefined; } /** *Sets or shows user pool email message configuration for MFA. Includes the subject and * body of the email message template for MFA messages. To activate this setting, * advanced security features must be active in your user pool.
*This data type is a request parameter of SetUserPoolMfaConfig and a response parameter of GetUserPoolMfaConfig.
* @public */ export interface EmailMfaConfigType { /** *The template for the email message that your user pool sends to users with an MFA
* code. The message must contain the \{####\} placeholder. In the message,
* Amazon Cognito replaces this placeholder with the code. If you don't provide this parameter,
* Amazon Cognito sends messages in the default format.
The subject of the email message that your user pool sends to users with an MFA * code.
* @public */ Subject?: string | undefined; } /** *The configuration of multi-factor authentication (MFA) with SMS messages in a user * pool.
*This data type is a request parameter of SetUserPoolMfaConfig and a response parameter of GetUserPoolMfaConfig.
* @public */ export interface SmsMfaConfigType { /** *The SMS authentication message that will be sent to users with the code they must sign
* in with. The message must contain the \{####\} placeholder. Your user pool
* replaces the placeholder with the MFA code. If this parameter isn't provided, your user
* pool sends a default message.
User pool configuration for delivery of SMS messages with 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.
*You can set SmsConfiguration in CreateUserPool and
* UpdateUserPool, or in SetUserPoolMfaConfig.
Settings for time-based one-time password (TOTP) multi-factor authentication (MFA) in * a user pool. Enables and disables availability of this feature.
*This data type is a request parameter of SetUserPoolMfaConfig and a response parameter of GetUserPoolMfaConfig.
* @public */ export interface SoftwareTokenMfaConfigType { /** *The activation state of TOTP MFA.
* @public */ Enabled?: boolean | undefined; } /** * @public * @enum */ export declare const UserVerificationType: { readonly PREFERRED: "preferred"; readonly REQUIRED: "required"; }; /** * @public */ export type UserVerificationType = (typeof UserVerificationType)[keyof typeof UserVerificationType]; /** * @internal */ export declare const AdminAddUserToGroupRequestFilterSensitiveLog: (obj: AdminAddUserToGroupRequest) => any; /** * @internal */ export declare const AdminConfirmSignUpRequestFilterSensitiveLog: (obj: AdminConfirmSignUpRequest) => any; /** * @internal */ export declare const AttributeTypeFilterSensitiveLog: (obj: AttributeType) => any; /** * @internal */ export declare const AdminCreateUserRequestFilterSensitiveLog: (obj: AdminCreateUserRequest) => any; /** * @internal */ export declare const UserTypeFilterSensitiveLog: (obj: UserType) => any; /** * @internal */ export declare const AdminCreateUserResponseFilterSensitiveLog: (obj: AdminCreateUserResponse) => any; /** * @internal */ export declare const AdminDeleteUserRequestFilterSensitiveLog: (obj: AdminDeleteUserRequest) => any; /** * @internal */ export declare const AdminDeleteUserAttributesRequestFilterSensitiveLog: (obj: AdminDeleteUserAttributesRequest) => any; /** * @internal */ export declare const AdminDisableUserRequestFilterSensitiveLog: (obj: AdminDisableUserRequest) => any; /** * @internal */ export declare const AdminEnableUserRequestFilterSensitiveLog: (obj: AdminEnableUserRequest) => any; /** * @internal */ export declare const AdminForgetDeviceRequestFilterSensitiveLog: (obj: AdminForgetDeviceRequest) => any; /** * @internal */ export declare const AdminGetDeviceRequestFilterSensitiveLog: (obj: AdminGetDeviceRequest) => any; /** * @internal */ export declare const DeviceTypeFilterSensitiveLog: (obj: DeviceType) => any; /** * @internal */ export declare const AdminGetDeviceResponseFilterSensitiveLog: (obj: AdminGetDeviceResponse) => any; /** * @internal */ export declare const AdminGetUserRequestFilterSensitiveLog: (obj: AdminGetUserRequest) => any; /** * @internal */ export declare const AdminGetUserResponseFilterSensitiveLog: (obj: AdminGetUserResponse) => any; /** * @internal */ export declare const AdminInitiateAuthRequestFilterSensitiveLog: (obj: AdminInitiateAuthRequest) => any; /** * @internal */ export declare const AuthenticationResultTypeFilterSensitiveLog: (obj: AuthenticationResultType) => any; /** * @internal */ export declare const AdminInitiateAuthResponseFilterSensitiveLog: (obj: AdminInitiateAuthResponse) => any; /** * @internal */ export declare const AdminListDevicesRequestFilterSensitiveLog: (obj: AdminListDevicesRequest) => any; /** * @internal */ export declare const AdminListDevicesResponseFilterSensitiveLog: (obj: AdminListDevicesResponse) => any; /** * @internal */ export declare const AdminListGroupsForUserRequestFilterSensitiveLog: (obj: AdminListGroupsForUserRequest) => any; /** * @internal */ export declare const AdminListUserAuthEventsRequestFilterSensitiveLog: (obj: AdminListUserAuthEventsRequest) => any; /** * @internal */ export declare const AdminRemoveUserFromGroupRequestFilterSensitiveLog: (obj: AdminRemoveUserFromGroupRequest) => any; /** * @internal */ export declare const AdminResetUserPasswordRequestFilterSensitiveLog: (obj: AdminResetUserPasswordRequest) => any; /** * @internal */ export declare const AdminRespondToAuthChallengeRequestFilterSensitiveLog: (obj: AdminRespondToAuthChallengeRequest) => any; /** * @internal */ export declare const AdminRespondToAuthChallengeResponseFilterSensitiveLog: (obj: AdminRespondToAuthChallengeResponse) => any; /** * @internal */ export declare const AdminSetUserMFAPreferenceRequestFilterSensitiveLog: (obj: AdminSetUserMFAPreferenceRequest) => any; /** * @internal */ export declare const AdminSetUserPasswordRequestFilterSensitiveLog: (obj: AdminSetUserPasswordRequest) => any; /** * @internal */ export declare const AdminSetUserSettingsRequestFilterSensitiveLog: (obj: AdminSetUserSettingsRequest) => any; /** * @internal */ export declare const AdminUpdateAuthEventFeedbackRequestFilterSensitiveLog: (obj: AdminUpdateAuthEventFeedbackRequest) => any; /** * @internal */ export declare const AdminUpdateDeviceStatusRequestFilterSensitiveLog: (obj: AdminUpdateDeviceStatusRequest) => any; /** * @internal */ export declare const AdminUpdateUserAttributesRequestFilterSensitiveLog: (obj: AdminUpdateUserAttributesRequest) => any; /** * @internal */ export declare const AdminUserGlobalSignOutRequestFilterSensitiveLog: (obj: AdminUserGlobalSignOutRequest) => any; /** * @internal */ export declare const AssociateSoftwareTokenRequestFilterSensitiveLog: (obj: AssociateSoftwareTokenRequest) => any; /** * @internal */ export declare const AssociateSoftwareTokenResponseFilterSensitiveLog: (obj: AssociateSoftwareTokenResponse) => any; /** * @internal */ export declare const ChangePasswordRequestFilterSensitiveLog: (obj: ChangePasswordRequest) => any; /** * @internal */ export declare const CompleteWebAuthnRegistrationRequestFilterSensitiveLog: (obj: CompleteWebAuthnRegistrationRequest) => any; /** * @internal */ export declare const ConfirmDeviceRequestFilterSensitiveLog: (obj: ConfirmDeviceRequest) => any; /** * @internal */ export declare const UserContextDataTypeFilterSensitiveLog: (obj: UserContextDataType) => any; /** * @internal */ export declare const ConfirmForgotPasswordRequestFilterSensitiveLog: (obj: ConfirmForgotPasswordRequest) => any; /** * @internal */ export declare const ConfirmSignUpRequestFilterSensitiveLog: (obj: ConfirmSignUpRequest) => any; /** * @internal */ export declare const ConfirmSignUpResponseFilterSensitiveLog: (obj: ConfirmSignUpResponse) => any; /** * @internal */ export declare const CreateManagedLoginBrandingRequestFilterSensitiveLog: (obj: CreateManagedLoginBrandingRequest) => any; /** * @internal */ export declare const UserPoolClientTypeFilterSensitiveLog: (obj: UserPoolClientType) => any; /** * @internal */ export declare const CreateUserPoolClientResponseFilterSensitiveLog: (obj: CreateUserPoolClientResponse) => any; /** * @internal */ export declare const DeleteUserRequestFilterSensitiveLog: (obj: DeleteUserRequest) => any; /** * @internal */ export declare const DeleteUserAttributesRequestFilterSensitiveLog: (obj: DeleteUserAttributesRequest) => any; /** * @internal */ export declare const DeleteUserPoolClientRequestFilterSensitiveLog: (obj: DeleteUserPoolClientRequest) => any; /** * @internal */ export declare const DeleteWebAuthnCredentialRequestFilterSensitiveLog: (obj: DeleteWebAuthnCredentialRequest) => any; /** * @internal */ export declare const DescribeManagedLoginBrandingByClientRequestFilterSensitiveLog: (obj: DescribeManagedLoginBrandingByClientRequest) => any; /** * @internal */ export declare const DescribeRiskConfigurationRequestFilterSensitiveLog: (obj: DescribeRiskConfigurationRequest) => any; /** * @internal */ export declare const RiskConfigurationTypeFilterSensitiveLog: (obj: RiskConfigurationType) => any; /** * @internal */ export declare const DescribeRiskConfigurationResponseFilterSensitiveLog: (obj: DescribeRiskConfigurationResponse) => any; /** * @internal */ export declare const DescribeUserPoolClientRequestFilterSensitiveLog: (obj: DescribeUserPoolClientRequest) => any; /** * @internal */ export declare const DescribeUserPoolClientResponseFilterSensitiveLog: (obj: DescribeUserPoolClientResponse) => any; /** * @internal */ export declare const ForgetDeviceRequestFilterSensitiveLog: (obj: ForgetDeviceRequest) => any; /** * @internal */ export declare const ForgotPasswordRequestFilterSensitiveLog: (obj: ForgotPasswordRequest) => any; /** * @internal */ export declare const GetDeviceRequestFilterSensitiveLog: (obj: GetDeviceRequest) => any; /** * @internal */ export declare const GetDeviceResponseFilterSensitiveLog: (obj: GetDeviceResponse) => any; /** * @internal */ export declare const GetUICustomizationRequestFilterSensitiveLog: (obj: GetUICustomizationRequest) => any; /** * @internal */ export declare const UICustomizationTypeFilterSensitiveLog: (obj: UICustomizationType) => any; /** * @internal */ export declare const GetUICustomizationResponseFilterSensitiveLog: (obj: GetUICustomizationResponse) => any; /** * @internal */ export declare const GetUserRequestFilterSensitiveLog: (obj: GetUserRequest) => any; /** * @internal */ export declare const GetUserResponseFilterSensitiveLog: (obj: GetUserResponse) => any; /** * @internal */ export declare const GetUserAttributeVerificationCodeRequestFilterSensitiveLog: (obj: GetUserAttributeVerificationCodeRequest) => any; /** * @internal */ export declare const GetUserAuthFactorsRequestFilterSensitiveLog: (obj: GetUserAuthFactorsRequest) => any; /** * @internal */ export declare const GetUserAuthFactorsResponseFilterSensitiveLog: (obj: GetUserAuthFactorsResponse) => any;