A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
* aws.cognito.signin.user.admin.
The name of the user who is eligible for the authentication factors in the * response.
* @public */ Username: string | undefined; /** *The challenge method that Amazon Cognito returns to the user in response to sign-in requests. * Users can prefer SMS message, email message, or TOTP MFA.
* @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, for example ["PASSWORD", "WEB_AUTHN"].
The ID of the user pool where you want to query WebAuthn and MFA configuration.
* @public */ UserPoolId: string | undefined; } /** *Sets or shows configuration for user pool email message MFA and sign-in with one-time * passwords (OTPs). Includes the subject and body of the email message template for * sign-in and MFA messages. To activate this setting, your user pool must be in the * Essentials tier or higher.
* @public */ export interface EmailMfaConfigType { /** *The template for the email messages that your user pool sends to users with codes for
* MFA and sign-in with email OTPs. 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 messages that your user pool sends to users with codes for * MFA and email OTP sign-in.
* @public */ Subject?: string | undefined; } /** *The configuration of multi-factor authentication (MFA) with SMS messages in a user * pool.
* @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.
* @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]; /** *Settings for authentication (MFA) with passkey, or webauthN, biometric and * security-key devices in a user pool. Configures the following:
*Configuration for requiring user-verification support in passkeys.
*The user pool relying-party ID. This is the domain, typically your user pool * domain, that user's passkey providers should trust as a receiver of passkey * authentication.
*The providers that you want to allow as origins for passkey * authentication.
*Sets or displays the authentication domain, typically your user pool domain, that * passkey providers must use as a relying party (RP) in their configuration.
*Under the following conditions, the passkey relying party ID must be the * fully-qualified domain name of your custom domain:
*The user pool is configured for passkey authentication.
*The user pool has a custom domain, whether or not it also has a prefix * domain.
*Your application performs authentication with managed login or the classic * hosted UI.
*When required, users can only register and sign in users with passkeys
* that are capable of user
* verification. When preferred, your user pool doesn't
* require the use of authenticators with user verification but encourages it.
Shows user pool configuration for SMS message MFA. Includes the message template and * the SMS message sending configuration for Amazon SNS.
* @public */ SmsMfaConfiguration?: SmsMfaConfigType | undefined; /** *Shows user pool configuration for time-based one-time password (TOTP) MFA. Includes * TOTP enabled or disabled state.
* @public */ SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType | undefined; /** *Shows configuration for user pool email message MFA and sign-in with one-time * passwords (OTPs). Includes the subject and body of the email message template for * sign-in and MFA messages. To activate this setting, your user pool must be in the * Essentials tier or higher.
* @public */ EmailMfaConfiguration?: EmailMfaConfigType | undefined; /** *Displays the state of multi-factor authentication (MFA) as on, off, or optional. When
* ON, all users must set up MFA before they can sign in. When
* OPTIONAL, your application must make a client-side determination of
* whether a user wants to register an MFA device. For user pools with adaptive
* authentication with threat protection, choose OPTIONAL.
When MfaConfiguration is OPTIONAL, managed login
* doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in
* API responses and in managed login for users who have chosen and configured a preferred
* MFA factor.
Shows user pool configuration for sign-in with passkey authenticators like biometric
* devices and security keys. Passkeys are not eligible MFA factors. They are instead an
* eligible primary sign-in factor for choice-based authentication, or the
* USER_AUTH flow.
Represents the request to sign out all devices.
* @public */ export interface GlobalSignOutRequest { /** *A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
* aws.cognito.signin.user.admin.
The response to the request to sign out all devices.
* @public */ export interface GlobalSignOutResponse { } /** *Initiates the authentication request.
* @public */ export interface InitiateAuthRequest { /** *The authentication flow that you want to initiate. Each AuthFlow has
* linked AuthParameters that you must submit. The following are some example
* flows.
The entry point for choice-based authentication with passwords, * one-time passwords, and WebAuthn authenticators. 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. * To activate this setting, your user pool must be in the * Essentials tier or higher.
*Username-password authentication with the Secure Remote Password (SRP) * protocol. For more information, see Use SRP password verification in custom * authentication flow.
*Receive new ID and access tokens when you pass a
* REFRESH_TOKEN parameter with a valid refresh token as the
* value. For more information, see Using the refresh token.
Custom authentication with Lambda triggers. For more information, see * Custom authentication challenge Lambda * triggers.
*Client-side username-password authentication with the password sent * directly in the request. For more information about client-side and * server-side authentication, see SDK authorization models.
*
* ADMIN_USER_PASSWORD_AUTH is a flow type of AdminInitiateAuth
* and isn't valid for InitiateAuth. ADMIN_NO_SRP_AUTH is a legacy server-side
* username-password flow and isn't valid for InitiateAuth.
The authentication parameters. These are inputs corresponding to the
* AuthFlow that you're invoking.
The required values are specific to the InitiateAuthRequest$AuthFlow.
*The following are some authentication flows and their parameters. Add a
* SECRET_HASH parameter if your app client has a client secret.
* 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.
* USER_SRP_AUTH: USERNAME (required),
* SRP_A (required), DEVICE_KEY.
* USER_PASSWORD_AUTH: USERNAME (required),
* PASSWORD (required), DEVICE_KEY.
* REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN
* (required), DEVICE_KEY.
* 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 send an InitiateAuth request, 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 sign-up
*Pre authentication
*User migration
*When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload as input
* to the function. This payload contains a validationData attribute with the
* data that you assigned to the ClientMetadata parameter in your
* InitiateAuth request. In your function, validationData can
* contribute to operations that require data that isn't in the default
* payload.
* InitiateAuth requests invokes the following triggers without
* ClientMetadata 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 * Using Lambda triggers in the Amazon Cognito Developer Guide.
*When you use the ClientMetadata parameter, note 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 send sensitive
* information in this parameter.
The ID of the app client that your user wants to sign in to.
* @public */ ClientId: string | undefined; /** *Information that supports analytics outcomes with Amazon Pinpoint, including the * user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, * email address, or phone number.
* @public */ AnalyticsMetadata?: AnalyticsMetadataType | undefined; /** *Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat * protection 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.
*For more information, see Collecting data for threat protection in * applications.
* @public */ UserContextData?: UserContextDataType | 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. When you pass the session ID to InitiateAuth, Amazon Cognito assumes the SMS
* or email message one-time verification password from ConfirmSignUp as the
* primary authentication factor. You're not required to submit this code a second
* time. This option is only valid for users who have confirmed their sign-up and are
* signing in for the first time within the authentication flow session duration of the
* session ID.
Initiates the authentication response.
* @public */ export interface InitiateAuthResponse { /** *The name of an additional authentication challenge that you must respond to.
*Possible challenges include the following:
*All of the following challenges require USERNAME and, when the app
* client has a client secret, SECRET_HASH in the parameters.
* WEB_AUTHN: Respond to the challenge with the results of a
* successful authentication with a WebAuthn authenticator, or passkey. Examples
* of WebAuthn authenticators include biometric devices and 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.
* SMS_MFA: Respond with an
* SMS_MFA_CODE that your user pool delivered in an SMS message.
* EMAIL_OTP: Respond with an
* EMAIL_OTP_CODE that your user pool delivered in an email
* message.
* PASSWORD_VERIFIER: Respond with
* PASSWORD_CLAIM_SIGNATURE,
* PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after
* 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. The parameters of the challenge are determined by your Lambda function.
* DEVICE_SRP_AUTH: Respond with the initial parameters of device SRP
* authentication. For more information, see Signing in with a device.
* DEVICE_PASSWORD_VERIFIER: Respond with
* PASSWORD_CLAIM_SIGNATURE,
* PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after
* client-side SRP calculations. For more information, see Signing in with a device.
* 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.
Amazon Cognito only returns this challenge for users who have temporary passwords. * When you create passwordless users, you must provide values for all required * attributes.
*In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value.
* In AdminRespondToAuthChallenge or RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the
* requiredAttributes parameter, then use the AdminUpdateUserAttributes or UpdateUserAttributes API
* operation to modify the value of any additional attributes.
* MFA_SETUP: For users who are required to setup 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 time-based one-time password (TOTP) MFA, use the session returned
* in this challenge from InitiateAuth or AdminInitiateAuth
* as an input to AssociateSoftwareToken. Then, use the session returned
* by VerifySoftwareToken as an input to
* RespondToAuthChallenge or AdminRespondToAuthChallenge
* with challenge name MFA_SETUP to complete sign-in.
*
To set up SMS or email MFA, collect a phone_number or
* email attribute for the user. Then restart the authentication
* flow with an InitiateAuth or AdminInitiateAuth request.
*
The session identifier that links a challenge response to the initial authentication * request. If the user must pass another challenge, Amazon Cognito returns a session ID and * challenge parameters.
* @public */ Session?: string | undefined; /** *The required parameters of the ChallengeName challenge.
All challenges require USERNAME. They also require
* SECRET_HASH if your app client has a client secret.
The result of a successful and complete authentication request. This result is only
* returned if the user doesn't need to pass another challenge. If they must pass another
* challenge before they get tokens, Amazon Cognito returns a challenge in
* ChallengeName, ChallengeParameters, and
* Session response parameters.
This response parameter lists the available authentication challenges that users can * select from in choice-based authentication. For example, they might be * able to choose between passkey authentication, a one-time password from an SMS message, * and a traditional password.
* @public */ AvailableChallenges?: ChallengeNameType[] | undefined; } /** *Represents the request to list the devices.
* @public */ export interface ListDevicesRequest { /** *A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
* aws.cognito.signin.user.admin.
The maximum number of devices that you want Amazon Cognito to return in the response.
* @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; } /** *Represents the response to list devices.
* @public */ export interface ListDevicesResponse { /** *An array of devices and their details. Each entry that's returned includes device * information, last-accessed and created dates, and the device key.
* @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 ListGroupsRequest { /** *The ID of the user pool where you want to list user groups.
* @public */ UserPoolId: string | undefined; /** *The maximum number of groups that you want Amazon Cognito to return in the response.
* @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 */ NextToken?: string | undefined; } /** * @public */ export interface ListGroupsResponse { /** *An array of groups and their details. Each entry that's returned includes * description, precedence, and IAM role values.
* @public */ Groups?: GroupType[] | 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 */ NextToken?: string | undefined; } /** * @public */ export interface ListIdentityProvidersRequest { /** *The ID of the user pool where you want to list IdPs.
* @public */ UserPoolId: string | undefined; /** *The maximum number of IdPs that you want Amazon Cognito to return in the response.
* @public */ MaxResults?: 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 */ NextToken?: string | undefined; } /** *The details of a user pool identity provider (IdP), including name and type.
* @public */ export interface ProviderDescription { /** *The name of the IdP, for example MySAMLProvider.
The type of the provider, for example SAML. Amazon Cognito supports SAML 2.0,
* OIDC, and social IdPs. User pools list supported social IdPs by name in this response
* parameter: Facebook, Google, Login with Amazon, and Sign in with Apple.
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.
An array of the IdPs in your user pool. For each, the response includes identifiers, * the IdP name and type, and trust-relationship details like the issuer URL.
* @public */ Providers: ProviderDescription[] | 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 */ NextToken?: string | undefined; } /** * @public */ export interface ListResourceServersRequest { /** *The ID of the user pool where you want to list resource servers.
* @public */ UserPoolId: string | undefined; /** *The maximum number of resource servers that you want Amazon Cognito to return in the * response.
* @public */ MaxResults?: 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 */ NextToken?: string | undefined; } /** * @public */ export interface ListResourceServersResponse { /** *An array of resource servers and the details of their configuration. For each, the * response includes names, identifiers, and custom scopes.
* @public */ ResourceServers: ResourceServerType[] | 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 */ NextToken?: string | undefined; } /** * @public */ export interface ListTagsForResourceRequest { /** *The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.
* @public */ ResourceArn: string | undefined; } /** * @public */ export interface ListTagsForResourceResponse { /** *The tags that are assigned to the user pool.
* @public */ Tags?: RecordRepresents the request to list the user import jobs.
* @public */ export interface ListUserImportJobsRequest { /** *The ID of the user pool where you want to list import jobs.
* @public */ UserPoolId: string | undefined; /** *The maximum number of import jobs that you want Amazon Cognito to return in the * response.
* @public */ MaxResults: 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; } /** *Represents the response from the server to the request to list the user import * jobs.
* @public */ export interface ListUserImportJobsResponse { /** *An array of user import jobs from the requested user pool. For each, the response * includes logging destination, status, and the Amazon S3 pre-signed URL for CSV upload.
* @public */ UserImportJobs?: UserImportJobType[] | 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; } /** *Represents the request to list the user pool clients.
* @public */ export interface ListUserPoolClientsRequest { /** *The ID of the user pool where you want to list user pool clients.
* @public */ UserPoolId: string | undefined; /** *The maximum number of app clients that you want Amazon Cognito to return in the * response.
* @public */ MaxResults?: 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 */ NextToken?: string | undefined; } /** *A short description of a user pool app client.
* @public */ export interface UserPoolClientDescription { /** *The app client ID.
* @public */ ClientId?: string | undefined; /** *The ID of the user pool that's associated with the app client.
* @public */ UserPoolId?: string | undefined; /** *The app client name.
* @public */ ClientName?: string | undefined; } /** *Represents the response from the server that lists user pool clients.
* @public */ export interface ListUserPoolClientsResponse { /** *An array of app clients and their details. Includes app client ID and name.
* @public */ UserPoolClients?: UserPoolClientDescription[] | 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 */ NextToken?: string | undefined; } /** *Represents the request to list user pools.
* @public */ export interface ListUserPoolsRequest { /** *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 */ NextToken?: string | undefined; /** *The maximum number of user pools that you want Amazon Cognito to return in the response.
* @public */ MaxResults: number | undefined; } /** *A short description of a user pool.
* @public */ export interface UserPoolDescriptionType { /** *The user pool ID.
* @public */ Id?: string | undefined; /** *The user pool name.
* @public */ Name?: string | undefined; /** *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; /** *The user pool status.
* * @deprecated * @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.
Represents the response to list user pools.
* @public */ export interface ListUserPoolsResponse { /** *An array of user pools and their configuration details.
* @public */ UserPools?: UserPoolDescriptionType[] | 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 */ NextToken?: string | undefined; } /** *Represents the request to list users.
* @public */ export interface ListUsersRequest { /** *The ID of the user pool where you want to display or search for users.
* @public */ UserPoolId: string | undefined; /** *A JSON array of user attribute names, for example given_name, that you
* want Amazon Cognito to include in the response for each user. When you don't provide an
* AttributesToGet parameter, Amazon Cognito returns all attributes for each
* user.
Use AttributesToGet with required attributes in your user pool, or in
* conjunction with Filter. Amazon Cognito returns an error if not all users in the
* results have set a value for the attribute you request. Attributes that you can't
* filter on, including custom attributes, must have a value set in every user profile
* before an AttributesToGet parameter returns results.
The maximum number of users that you want Amazon Cognito to return in the response.
* @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; /** *A filter string of the form "AttributeName Filter-Type "AttributeValue".
* Quotation marks within the filter string must be escaped using the backslash
* (\) character. For example, "family_name =
* \"Reddy\"".
* AttributeName: The name of the attribute to search for. * You can only search for one attribute at a time.
*
* Filter-Type: For an exact match, use =, for
* example, "given_name = \"Jon\"". For a prefix ("starts with")
* match, use ^=, for example, "given_name ^= \"Jon\"".
*
* AttributeValue: The attribute value that must be matched * for each user.
*If the filter string is empty, ListUsers returns all users in the user
* pool.
You can only search for the following standard attributes:
*
* username (case-sensitive)
* email
*
* phone_number
*
* name
*
* given_name
*
* family_name
*
* preferred_username
*
* cognito:user_status (called Status in the Console) (case-insensitive)
* status (called Enabled in the Console)
* (case-sensitive)
*
* sub
*
Custom attributes aren't searchable.
*You can also list users with a client-side filter. The server-side filter matches
* no more than one attribute. For an advanced search, use a client-side filter with
* the --query parameter of the list-users action in the
* CLI. When you use a client-side filter, ListUsers returns a paginated list of zero
* or more users. You can receive multiple pages in a row with zero results. Repeat the
* query with each pagination token that is returned until you receive a null
* pagination token value, and then review the combined result.
For more information about server-side and client-side filtering, see FilteringCLI output in the Command Line Interface * User Guide.
*For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer * Guide.
* @public */ Filter?: string | undefined; } /** *The response from the request to list users.
* @public */ export interface ListUsersResponse { /** *An array of user pool users who match your query, and their attributes.
* @public */ Users?: UserType[] | 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 ListUsersInGroupRequest { /** *The ID of the user pool where you want to view the membership of the requested * group.
* @public */ UserPoolId: string | undefined; /** *The name of the group that you want to query for user membership.
* @public */ GroupName: string | undefined; /** *The maximum number of groups that you want Amazon Cognito to return in the response.
* @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 */ NextToken?: string | undefined; } /** * @public */ export interface ListUsersInGroupResponse { /** *An array of users who are members in the group, and their attributes.
* @public */ Users?: UserType[] | 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 */ NextToken?: string | undefined; } /** * @public */ export interface ListWebAuthnCredentialsRequest { /** *A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
* aws.cognito.signin.user.admin.
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 */ NextToken?: string | undefined; /** *The maximum number of the user's passkey credentials that you want to * return.
* @public */ MaxResults?: number | undefined; } /** *The details of a passkey, or webauthN, biometric or security-key authentication factor * for a user.
* @public */ export interface WebAuthnCredentialDescription { /** *The unique identifier of the passkey credential.
* @public */ CredentialId: string | undefined; /** *An automatically-generated friendly name for the passkey credential.
* @public */ FriendlyCredentialName: string | undefined; /** *The relying-party ID of the provider for the passkey credential.
* @public */ RelyingPartyId: string | undefined; /** *The general category of the passkey authenticator. Can be a platform, or on-device * authenticator like a built-in fingerprint scanner, or a cross-platform device that's not * attached to the device like a Bluetooth security key.
* @public */ AuthenticatorAttachment?: string | undefined; /** *Information about the transport methods of the passkey credential, for example USB or * Bluetooth Low Energy.
* @public */ AuthenticatorTransports: 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.
A list of registered passkeys for a user.
* @public */ Credentials: WebAuthnCredentialDescription[] | 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 */ NextToken?: string | undefined; } /** *Represents the request to resend the confirmation code.
* @public */ export interface ResendConfirmationCodeRequest { /** *The ID of the user pool app client where the user signed up.
* @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.
Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat * protection 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.
*For more information, see Collecting data for threat protection in * applications.
* @public */ UserContextData?: UserContextDataType | undefined; /** *The name 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 that supports analytics outcomes with Amazon Pinpoint, including the * user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, * email address, or phone number.
* @public */ AnalyticsMetadata?: AnalyticsMetadataType | 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 ResendConfirmationCode 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 ResendConfirmationCode 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 * Using Lambda triggers in the Amazon Cognito Developer Guide.
*When you use the ClientMetadata parameter, note 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 send sensitive
* information in this parameter.
The response from the server when Amazon Cognito makes the request to resend a confirmation * code.
* @public */ export interface ResendConfirmationCodeResponse { /** *Information about the phone number or email address that Amazon Cognito sent the confirmation * code to.
* @public */ CodeDeliveryDetails?: CodeDeliveryDetailsType | undefined; } /** *The request to respond to an authentication challenge.
* @public */ export interface RespondToAuthChallengeRequest { /** *The ID of the app client where the user is signing in.
* @public */ ClientId: string | undefined; /** *The name of the challenge that you are responding to.
*You can't respond to an ADMIN_NO_SRP_AUTH challenge with this
* operation.
Possible challenges include the following:
*All of the following challenges require USERNAME and, when the app
* client has a client secret, SECRET_HASH in the parameters.
* WEB_AUTHN: Respond to the challenge with the results of a
* successful authentication with a WebAuthn authenticator, or passkey. Examples
* of WebAuthn authenticators include biometric devices and 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.
* SMS_MFA: Respond with an
* SMS_MFA_CODE that your user pool delivered in an SMS message.
* EMAIL_OTP: Respond with an
* EMAIL_OTP_CODE that your user pool delivered in an email
* message.
* PASSWORD_VERIFIER: Respond with
* PASSWORD_CLAIM_SIGNATURE,
* PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after
* 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. The parameters of the challenge are determined by your Lambda function.
* DEVICE_SRP_AUTH: Respond with the initial parameters of device SRP
* authentication. For more information, see Signing in with a device.
* DEVICE_PASSWORD_VERIFIER: Respond with
* PASSWORD_CLAIM_SIGNATURE,
* PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after
* client-side SRP calculations. For more information, see Signing in with a device.
* 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.
Amazon Cognito only returns this challenge for users who have temporary passwords. * When you create passwordless users, you must provide values for all required * attributes.
*In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value.
* In AdminRespondToAuthChallenge or RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the
* requiredAttributes parameter, then use the AdminUpdateUserAttributes or UpdateUserAttributes API
* operation to modify the value of any additional attributes.
* MFA_SETUP: For users who are required to setup 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 time-based one-time password (TOTP) MFA, use the session returned
* in this challenge from InitiateAuth or AdminInitiateAuth
* as an input to AssociateSoftwareToken. Then, use the session returned
* by VerifySoftwareToken as an input to
* RespondToAuthChallenge or AdminRespondToAuthChallenge
* with challenge name MFA_SETUP to complete sign-in.
*
To set up SMS or email MFA, collect a phone_number or
* email attribute for the user. Then restart the authentication
* flow with an InitiateAuth or AdminInitiateAuth request.
*
The session identifier that maintains the state of authentication requests and
* challenge responses. If an AdminInitiateAuth or
* AdminRespondToAuthChallenge API request results in a determination that
* your application must pass another challenge, Amazon Cognito returns a session with other
* challenge parameters. Send this session identifier, unmodified, to the next
* AdminRespondToAuthChallenge request.
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 AdminRespondToAuthChallenge or RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the
* requiredAttributes parameter, then use the AdminUpdateUserAttributes or 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.
Information that supports analytics outcomes with Amazon Pinpoint, including the * user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, * email address, or phone number.
* @public */ AnalyticsMetadata?: AnalyticsMetadataType | undefined; /** *Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat * protection 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.
*For more information, see Collecting data for threat protection in * applications.
* @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 RespondToAuthChallenge API action, Amazon Cognito invokes any
* functions that are assigned to the following triggers: post
* authentication, pre token generation,
* define auth challenge, create auth
* challenge, and verify auth challenge. 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 RespondToAuthChallenge
* 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 * Using Lambda triggers in the Amazon Cognito Developer Guide.
*When you use the ClientMetadata parameter, note 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 send sensitive
* information in this parameter.
The response to respond to the authentication challenge.
* @public */ export interface RespondToAuthChallengeResponse { /** *The name of the next challenge that you must respond to.
*Possible challenges include the following:
*All of the following challenges require USERNAME and, when the app
* client has a client secret, SECRET_HASH in the parameters.
* WEB_AUTHN: Respond to the challenge with the results of a
* successful authentication with a WebAuthn authenticator, or passkey. Examples
* of WebAuthn authenticators include biometric devices and 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.
* SMS_MFA: Respond with an
* SMS_MFA_CODE that your user pool delivered in an SMS message.
* EMAIL_OTP: Respond with an
* EMAIL_OTP_CODE that your user pool delivered in an email
* message.
* PASSWORD_VERIFIER: Respond with
* PASSWORD_CLAIM_SIGNATURE,
* PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after
* 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. The parameters of the challenge are determined by your Lambda function.
* DEVICE_SRP_AUTH: Respond with the initial parameters of device SRP
* authentication. For more information, see Signing in with a device.
* DEVICE_PASSWORD_VERIFIER: Respond with
* PASSWORD_CLAIM_SIGNATURE,
* PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after
* client-side SRP calculations. For more information, see Signing in with a device.
* 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.
Amazon Cognito only returns this challenge for users who have temporary passwords. * When you create passwordless users, you must provide values for all required * attributes.
*In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value.
* In AdminRespondToAuthChallenge or RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the
* requiredAttributes parameter, then use the AdminUpdateUserAttributes or UpdateUserAttributes API
* operation to modify the value of any additional attributes.
* MFA_SETUP: For users who are required to setup 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 time-based one-time password (TOTP) MFA, use the session returned
* in this challenge from InitiateAuth or AdminInitiateAuth
* as an input to AssociateSoftwareToken. Then, use the session returned
* by VerifySoftwareToken as an input to
* RespondToAuthChallenge or AdminRespondToAuthChallenge
* with challenge name MFA_SETUP to complete sign-in.
*
To set up SMS or email MFA, collect a phone_number or
* email attribute for the user. Then restart the authentication
* flow with an InitiateAuth or AdminInitiateAuth request.
*
The session identifier that maintains the state of authentication requests and
* challenge responses. If an InitiateAuth or
* RespondToAuthChallenge API request results in a determination that your
* application must pass another challenge, Amazon Cognito returns a session with other challenge
* parameters. Send this session identifier, unmodified, to the next
* RespondToAuthChallenge request.
The parameters that define your response to the next challenge.
* @public */ ChallengeParameters?: RecordThe outcome of a successful authentication process. After your application has passed
* all challenges, Amazon Cognito returns an AuthenticationResult with the JSON web
* tokens (JWTs) that indicate successful sign-in.
The refresh token that you want to revoke.
* @public */ Token: string | undefined; /** *The ID of the app client where the token that you want to revoke was issued.
* @public */ ClientId: string | undefined; /** *The client secret of the requested app client, if the client has a secret.
* @public */ ClientSecret?: string | undefined; } /** * @public */ export interface RevokeTokenResponse { } /** *Exception that is thrown when the request isn't authorized. This can happen due to an * invalid access token in the request.
* @public */ export declare class UnauthorizedException extends __BaseException { readonly name: "UnauthorizedException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeException that is thrown when an unsupported token is passed to an operation.
* @public */ export declare class UnsupportedTokenTypeException extends __BaseException { readonly name: "UnsupportedTokenTypeException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe ID of the user pool where you want to configure logging.
* @public */ UserPoolId: string | undefined; /** *A collection of the logging configurations for a user pool.
* @public */ LogConfigurations: LogConfigurationType[] | undefined; } /** * @public */ export interface SetLogDeliveryConfigurationResponse { /** *The logging configuration that you applied to the requested user pool.
* @public */ LogDeliveryConfiguration?: LogDeliveryConfigurationType | undefined; } /** * @public */ export interface SetRiskConfigurationRequest { /** *The ID of the user pool where you want to set a risk configuration. If you include
* UserPoolId in your request, don't include ClientId.
* When the client ID is null, the same risk configuration is applied to all the clients in
* the userPool. When you include both ClientId and UserPoolId,
* Amazon Cognito maps the configuration to the app client only.
The ID of the app client where you want to set a risk configuration. If
* ClientId is null, then the risk configuration is mapped to
* UserPoolId. When the client ID is null, the same risk configuration is
* applied to all the clients in the userPool.
When you include a ClientId parameter, Amazon Cognito maps the configuration to
* the app client. When you include both ClientId and UserPoolId,
* Amazon Cognito maps the configuration to the app client only.
The configuration of automated reactions to detected compromised credentials. Includes * settings for blocking future sign-in requests and for the types of password-submission * events you want to monitor.
* @public */ CompromisedCredentialsRiskConfiguration?: CompromisedCredentialsRiskConfigurationType | undefined; /** *The settings for automated responses and notification templates for adaptive * authentication with threat protection.
* @public */ AccountTakeoverRiskConfiguration?: AccountTakeoverRiskConfigurationType | undefined; /** *A set of IP-address overrides to threat protection. You can set up IP-address * always-block and always-allow lists.
* @public */ RiskExceptionConfiguration?: RiskExceptionConfigurationType | undefined; } /** * @public */ export interface SetRiskConfigurationResponse { /** *The API response that contains the risk configuration that you set and the timestamp * of the most recent change.
* @public */ RiskConfiguration: RiskConfigurationType | undefined; } /** * @public */ export interface SetUICustomizationRequest { /** *The ID of the user pool where you want to apply branding to the classic hosted * UI.
* @public */ UserPoolId: string | undefined; /** *The ID of the app client that you want to customize. To apply a default style to all
* app clients not configured with client-level branding, set this parameter value to
* ALL.
A plaintext CSS file that contains the custom fields that you want to apply to your
* user pool or app client. To download a template, go to the Amazon Cognito console. Navigate to
* your user pool App clients tab, select Login
* pages, edit Hosted UI (classic) style, and select
* the link to CSS template.css.
The image that you want to set as your login in the classic hosted UI, as a * Base64-formatted binary object.
* @public */ ImageFile?: Uint8Array | undefined; } /** * @public */ export interface SetUICustomizationResponse { /** *Information about the hosted UI branding that you applied.
* @public */ UICustomization: UICustomizationType | undefined; } /** * @public */ export interface SetUserMFAPreferenceRequest { /** *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. * Users must register a TOTP authenticator before they set this as their preferred MFA * method.
* @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, your user pool must be in the * Essentials tier or higher.
* @public */ EmailMfaSettings?: EmailMfaSettingsType | undefined; /** *A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
* aws.cognito.signin.user.admin.
The user pool ID.
* @public */ UserPoolId: string | undefined; /** *Configures user pool SMS messages for MFA. Sets the message template and the SMS * message sending configuration for Amazon SNS.
* @public */ SmsMfaConfiguration?: SmsMfaConfigType | undefined; /** *Configures a user pool for time-based one-time password (TOTP) MFA. Enables or * disables TOTP.
* @public */ SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType | undefined; /** *Sets configuration for user pool email message MFA and sign-in with one-time passwords * (OTPs). Includes the subject and body of the email message template for sign-in and MFA * messages. To activate this setting, your user pool must be in the * Essentials tier or higher.
* @public */ EmailMfaConfiguration?: EmailMfaConfigType | undefined; /** *Sets multi-factor authentication (MFA) to be on, off, or optional. When
* ON, all users must set up MFA before they can sign in. When
* OPTIONAL, your application must make a client-side determination of
* whether a user wants to register an MFA device. For user pools with adaptive
* authentication with threat protection, choose OPTIONAL.
When MfaConfiguration is OPTIONAL, managed login
* doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in
* API responses and in managed login for users who have chosen and configured a preferred
* MFA factor.
The configuration of your user pool for passkey, or WebAuthn, authentication and * registration. You can set this configuration independent of the MFA configuration * options in this operation.
* @public */ WebAuthnConfiguration?: WebAuthnConfigurationType | undefined; } /** * @public */ export interface SetUserPoolMfaConfigResponse { /** *Shows user pool SMS message configuration for MFA and sign-in with SMS-message OTPs. * Includes the message template and the SMS message sending configuration for * Amazon SNS.
* @public */ SmsMfaConfiguration?: SmsMfaConfigType | undefined; /** *Shows user pool configuration for time-based one-time password (TOTP) MFA. Includes * TOTP enabled or disabled state.
* @public */ SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType | undefined; /** *Shows configuration for user pool email message MFA and sign-in with one-time * passwords (OTPs). Includes the subject and body of the email message template for * sign-in and MFA messages. To activate this setting, your user pool must be in the * Essentials tier or higher.
* @public */ EmailMfaConfiguration?: EmailMfaConfigType | undefined; /** *Displays multi-factor authentication (MFA) as on, off, or optional. When
* ON, all users must set up MFA before they can sign in. When
* OPTIONAL, your application must make a client-side determination of
* whether a user wants to register an MFA device. For user pools with adaptive
* authentication with threat protection, choose OPTIONAL.
When MfaConfiguration is OPTIONAL, managed login
* doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in
* API responses and in managed login for users who have chosen and configured a preferred
* MFA factor.
The configuration of your user pool for passkey, or WebAuthn, sign-in with * authenticators like biometric and security-key devices. Includes relying-party * configuration and settings for user-verification requirements.
* @public */ WebAuthnConfiguration?: WebAuthnConfigurationType | undefined; } /** *Represents the request to set user settings.
* @public */ export interface SetUserSettingsRequest { /** *A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
* aws.cognito.signin.user.admin.
You can use this parameter only to set an SMS configuration that uses SMS for * delivery.
* @public */ MFAOptions: MFAOptionType[] | undefined; } /** *The response from the server for a set user settings request.
* @public */ export interface SetUserSettingsResponse { } /** *Represents the request to register a user.
* @public */ export interface SignUpRequest { /** *The ID of the app client where the user wants to sign up.
* @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 sign up. The value of this parameter is * typically a username, but can be any alias attribute in your user pool.
* @public */ Username: string | undefined; /** *The user's proposed password. The password must comply with the password requirements of your user pool.
*Users can sign up without a password 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.
* @public */ Password?: string | undefined; /** *An array of name-value pairs representing user attributes.
*For custom attributes, include a custom: prefix in the attribute name,
* for example custom:department.
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 * can automatically confirm and verify select users or perform external API operations * like logging user attributes and validation data to Amazon CloudWatch Logs.
*For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger.
* @public */ ValidationData?: AttributeType[] | undefined; /** *Information that supports analytics outcomes with Amazon Pinpoint, including the * user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, * email address, or phone number.
* @public */ AnalyticsMetadata?: AnalyticsMetadataType | undefined; /** *Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat * protection 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.
*For more information, see Collecting data for threat protection in * applications.
* @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 SignUp API action, Amazon Cognito invokes any functions that are assigned to the
* following triggers: pre sign-up, custom
* message, and post confirmation. 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 SignUp 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 * Using Lambda triggers in the Amazon Cognito Developer Guide.
*When you use the ClientMetadata parameter, note 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 send sensitive
* information in this parameter.
The response from the server for a registration request.
* @public */ export interface SignUpResponse { /** *Indicates whether the user was automatically confirmed. You can auto-confirm users * with a pre sign-up Lambda trigger.
* @public */ UserConfirmed: boolean | undefined; /** *In user pools that automatically verify and confirm new users, Amazon Cognito sends users a
* message with a code or link that confirms ownership of the phone number or email address
* that they entered. The CodeDeliveryDetails object is information about the
* delivery destination for that link or code.
The unique identifier of the new user, for example
* a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
A session Id that you can pass to ConfirmSignUp when you want to
* immediately sign in your user with the USER_AUTH flow after they complete
* sign-up.
Represents the request to start the user import job.
* @public */ export interface StartUserImportJobRequest { /** *The ID of the user pool that you want to start importing users into.
* @public */ UserPoolId: string | undefined; /** *The ID of a user import job that you previously created.
* @public */ JobId: string | undefined; } /** *Represents the response from the server to the request to start the user import * job.
* @public */ export interface StartUserImportJobResponse { /** *The details of the user import job. Includes logging destination, status, and the Amazon S3 * pre-signed URL for CSV upload.
* @public */ UserImportJob?: UserImportJobType | undefined; } /** * @public */ export interface StartWebAuthnRegistrationRequest { /** *A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
* aws.cognito.signin.user.admin.
The information that a user can provide in their request to register with their * passkey provider.
* @public */ CredentialCreationOptions: __DocumentType | undefined; } /** *This exception is thrown when a user pool doesn't have a configured relying party * id or a user pool domain.
* @public */ export declare class WebAuthnConfigurationMissingException extends __BaseException { readonly name: "WebAuthnConfigurationMissingException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeRepresents the request to stop the user import job.
* @public */ export interface StopUserImportJobRequest { /** *The ID of the user pool that you want to stop.
* @public */ UserPoolId: string | undefined; /** *The ID of a running user import job.
* @public */ JobId: string | undefined; } /** *Represents the response from the server to the request to stop the user import * job.
* @public */ export interface StopUserImportJobResponse { /** *The details of the user import job. Includes logging destination, status, and the Amazon S3 * pre-signed URL for CSV upload.
* @public */ UserImportJob?: UserImportJobType | undefined; } /** * @public */ export interface TagResourceRequest { /** *The Amazon Resource Name (ARN) of the user pool to assign the tags to.
* @public */ ResourceArn: string | undefined; /** *An array of tag keys and values that you want to assign to the user pool.
* @public */ Tags: RecordThe Amazon Resource Name (ARN) of the user pool that the tags are assigned to.
* @public */ ResourceArn: string | undefined; /** *An array of tag keys that you want to remove from the user pool.
* @public */ TagKeys: string[] | undefined; } /** * @public */ export interface UntagResourceResponse { } /** * @public */ export interface UpdateAuthEventFeedbackRequest { /** *The ID of the user pool where you want to update auth event feedback.
* @public */ UserPoolId: string | undefined; /** *The name 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 authentication event that you want to submit feedback for.
* @public */ EventId: string | undefined; /** *The feedback token, an encrypted object generated by Amazon Cognito and passed to your user in * the notification email message from the event.
* @public */ FeedbackToken: string | undefined; /** *Your feedback to the authentication event. 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.
Represents the request to update the device status.
* @public */ export interface UpdateDeviceStatusRequest { /** *A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
* aws.cognito.signin.user.admin.
The device key of the device you want to update, for example
* us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
To enable device authentication with the specified device, set to
* remembered.To disable, set to not_remembered.
The response to the request to update the device status.
* @public */ export interface UpdateDeviceStatusResponse { } /** * @public */ export interface UpdateGroupRequest { /** *The name of the group that you want to update.
* @public */ GroupName: string | undefined; /** *The ID of the user pool that contains the group you want to update.
* @public */ UserPoolId: string | undefined; /** *A new description of the existing group.
* @public */ Description?: string | undefined; /** *The Amazon Resource Name (ARN) of an IAM role that you want to associate with the
* group. The role assignment contributes to the cognito:roles and
* cognito:preferred_role claims in group members' tokens.
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.
Contains the updated details of the group, including precedence, IAM role, and * description.
* @public */ Group?: GroupType | undefined; } /** * @public */ export interface UpdateIdentityProviderRequest { /** *The Id of the user pool where you want to update your IdP.
* @public */ UserPoolId: string | undefined; /** *The name of the IdP that you want to update. You can pass the identity provider name
* in the identity_provider query parameter of requests to the Authorize endpoint to silently redirect to sign-in with the associated
* IdP.
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. Specify a * user pool attribute as the key of the key-value pair, and the IdP attribute claim name * as the value.
* @public */ AttributeMapping?: RecordAn array of IdP identifiers, for example "IdPIdentifiers": [ "MyIdP", "MyIdP2"
* ]. Identifiers are friendly names that you can pass in the
* idp_identifier query parameter of requests to the Authorize endpoint to silently redirect to sign-in with the associated IdP.
* Identifiers in a domain format also enable the use of email-address matching with SAML providers.
The identity provider details.
* @public */ IdentityProvider: IdentityProviderType | undefined; } /** * @public */ export interface UpdateManagedLoginBrandingRequest { /** *The ID of the user pool that contains the managed login branding style that you want * to update.
* @public */ UserPoolId?: string | undefined; /** *The ID of the managed login branding style that you want to update.
* @public */ ManagedLoginBrandingId?: 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; } /** * @public */ export interface UpdateManagedLoginBrandingResponse { /** *The details of the branding style that you updated.
* @public */ ManagedLoginBranding?: ManagedLoginBrandingType | undefined; } /** * @public */ export interface UpdateResourceServerRequest { /** *The ID of the user pool that contains the resource server that you want to * update.
* @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 updated name of the resource server.
* @public */ Name: string | undefined; /** *An array of updated custom scope names and descriptions that you want to associate * with your resource server.
* @public */ Scopes?: ResourceServerScopeType[] | undefined; } /** * @public */ export interface UpdateResourceServerResponse { /** *The updated details of the requested resource server.
* @public */ ResourceServer: ResourceServerType | undefined; } /** *Represents the request to update user attributes.
* @public */ export interface UpdateUserAttributesRequest { /** *An array of name-value pairs representing user attributes.
*For custom attributes, you must add a custom: prefix to the attribute
* name.
If you have set an attribute to require verification before Amazon Cognito updates its value, * this request 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.
* @public */ UserAttributes: AttributeType[] | undefined; /** *A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
* aws.cognito.signin.user.admin.
A map of custom key-value pairs that you can provide as input for any custom workflows * that this action initiates.
*You create custom workflows by assigning Lambda functions to user pool triggers. When
* you use the UpdateUserAttributes 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 UpdateUserAttributes 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 * Using Lambda triggers in the Amazon Cognito Developer Guide.
*When you use the ClientMetadata parameter, note 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 send sensitive
* information in this parameter.
Represents the response from the server for the request to update user * attributes.
* @public */ export interface UpdateUserAttributesResponse { /** *When the attribute-update request includes an email address or phone number attribute,
* Amazon Cognito sends a message to users with a code that confirms ownership of the new value that
* they entered. The CodeDeliveryDetails object is information about the
* delivery destination for that link or code. This behavior happens in user pools
* configured to automatically verify changes to those attributes. For more information,
* see Verifying when users change their email or phone
* number.
Represents the request to update the user pool.
* @public */ export interface UpdateUserPoolRequest { /** *The ID of the user pool you want to update.
* @public */ UserPoolId: string | undefined; /** *The password policy and sign-in policy in the user pool. The password policy sets * options like password complexity requirements and password history. The sign-in policy * sets the options available to applications in choice-based authentication.
* @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 that you want your user pool to automatically verify. Possible values: * email, phone_number. For more information see Verifying contact information at sign-up.
* @public */ AutoVerifiedAttributes?: VerifiedAttributeType[] | undefined; /** *This parameter is no longer used.
* @public */ SmsVerificationMessage?: string | undefined; /** *This parameter is no longer used.
* @public */ EmailVerificationMessage?: string | undefined; /** *This parameter is no longer used.
* @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.
The contents of the SMS message that your user pool sends to users in SMS * authentication.
* @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.
Sets multi-factor authentication (MFA) to be on, off, or optional. When
* ON, all users must set up MFA before they can sign in. When
* OPTIONAL, your application must make a client-side determination of
* whether a user wants to register an MFA device. For user pools with adaptive
* authentication with threat protection, choose OPTIONAL.
When MfaConfiguration is OPTIONAL, managed login
* doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in
* API responses and in managed login for users who have chosen and configured a preferred
* MFA factor.
The device-remembering configuration for a user pool. Device remembering or device * tracking is a "Remember me on this device" option for user pools that perform * authentication with the device key of a trusted device in the back end, instead of a * user-provided MFA code. For more information about device authentication, see Working with user devices in your 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. For more information, see Working with devices.
The email configuration of your user pool. The email configuration type sets your * preferred sending method, Amazon Web Services Region, and sender for email invitation and verification * messages from your user pool.
* @public */ EmailConfiguration?: EmailConfigurationType | undefined; /** *The SMS configuration with the settings for your Amazon Cognito user pool to send SMS message * 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. For * more information see SMS message settings.
* @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 administrative creation of users. Includes the template for the * invitation message for new users, the duration of temporary passwords, and permitting * self-service sign-up.
* @public */ AdminCreateUserConfig?: AdminCreateUserConfigType | undefined; /** *Contains settings for activation of threat protection, including the operating
* mode and additional authentication types. To log user security information but take
* no action, set to AUDIT. To configure automatic security responses to
* potentially unwanted traffic to your user pool, set to ENFORCED.
For more information, see Adding advanced security to a user pool. To activate this setting, your user pool must be on the * Plus tier.
* @public */ UserPoolAddOns?: UserPoolAddOnsType | 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 updated name of your user pool.
* @public */ PoolName?: string | undefined; /** *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 when you make a request to update the user * pool.
* @public */ export interface UpdateUserPoolResponse { } /** *Represents the request to update the user pool client.
* @public */ export interface UpdateUserPoolClientRequest { /** *The ID of the user pool where you want to update the app client.
* @public */ UserPoolId: string | undefined; /** *The ID of the app client that you want to update.
* @public */ ClientId: string | undefined; /** *A friendly name for the app client.
* @public */ ClientName?: string | 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 that validity times are represented in. The default unit for refresh tokens * is days, and the 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.
*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.
*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 app client supports
* ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.
*
The values for authentication flow options include the following.
*
* 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.
*
To activate this setting, your user pool must be in the * Essentials tier or higher.
*
* 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 parameter sets the IdPs that managed
* login will display on the login page for your app client. 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
* SDK-based authentication is to block access with a WAF rule.
*
A list of allowed redirect, or callback, URLs for managed login authentication. These * URLs are the paths where you want to send your users' browsers after they complete * authentication with managed login or a third-party IdP. Typically, callback URLs are the * home of an application that uses OAuth or OIDC libraries to process authentication * outcomes.
*A redirect URI must meet the following requirements:
*Be an absolute URI.
*Be registered with the authorization server. Amazon Cognito doesn't accept
* authorization requests with redirect_uri values that aren't in
* the list of CallbackURLs that you provide in this parameter.
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.
A list of allowed logout URLs for managed login authentication. When you pass
* logout_uri and client_id parameters to
* /logout, Amazon Cognito signs out your user and redirects them to the logout
* URL. This parameter describes the URLs that you want to be the permitted targets of
* logout_uri. A typical use of these URLs is when a user selects "Sign
* out" and you redirect them to your public homepage. For more information, see Logout
* endpoint.
The default redirect URI. In app clients with one assigned IdP, replaces
* redirect_uri in authentication requests. Must be in the
* CallbackURLs list.
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, OpenID Connect (OIDC), and custom scopes that you want to permit your app
* client to authorize access with. Scopes govern access control to user pool self-service
* API operations, user data from the userInfo endpoint, and third-party APIs.
* Scope values include phone, email, openid, and
* profile. The aws.cognito.signin.user.admin scope
* authorizes user self-service operations. Custom scopes with resource servers authorize
* access to external APIs.
Set to true to use OAuth 2.0 authorization server features in your app client.
This parameter must have a value of 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 authorization server 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. When false, only SDK-based API sign-in is permitted.
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 might not have access to * analytics or might be configurable with campaigns in the US East (N. Virginia) Region. * For more information, see Using Amazon Pinpoint analytics.
* @public */ AnalyticsConfiguration?: AnalyticsConfigurationType | undefined; /** *When ENABLED, suppresses messages that might indicate a valid user exists
* when someone attempts sign-in. This parameters sets your preference for the 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.
Defaults to LEGACY.
Activates or deactivates token * revocation in the target app client.
* @public */ EnableTokenRevocation?: boolean | undefined; /** *When true, your application can include additional
* UserContextData in authentication requests. This data includes the IP
* address, and contributes to analysis by threat protection features. For more information
* about propagation of user context data, see Adding session data to API requests. If you don’t include this parameter,
* you can't send the source IP address to Amazon Cognito threat protection features. 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 your app client for refresh token rotation. When enabled, your * app client issues new ID, access, and refresh tokens when users renew their sessions * with refresh tokens. When disabled, token refresh issues only ID and access * tokens.
* @public */ RefreshTokenRotation?: RefreshTokenRotationType | undefined; } /** *Represents the response from the server to the request to update the user pool * client.
* @public */ export interface UpdateUserPoolClientResponse { /** *The updated details of your app client.
* @public */ UserPoolClient?: UserPoolClientType | undefined; } /** *The UpdateUserPoolDomain request input.
* @public */ export interface UpdateUserPoolDomainRequest { /** *The name of the domain that you want to update. For custom domains, this is the
* fully-qualified domain name, for example auth.example.com. For prefix
* domains, this is the prefix alone, such as myprefix.
The ID of the user pool that is associated with the domain you're updating.
* @public */ UserPoolId: string | undefined; /** *A version number that indicates the state of managed login for your domain. Version
* 1 is hosted UI (classic). Version 2 is the newer managed
* login with the branding designer. For more information, see Managed login.
The configuration for a custom domain that hosts managed login for your application.
* In an UpdateUserPoolDomain request, this parameter specifies an SSL
* certificate for the managed login hosted webserver. The certificate must be an ACM ARN
* in us-east-1.
When you create a custom domain, the passkey RP ID defaults to the custom domain. If * you had a prefix domain active, this will cause passkey integration for your prefix * domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey * integration working, you can explicitly set RP ID to the prefix domain.
* @public */ CustomDomainConfig?: CustomDomainConfigType | undefined; } /** *The UpdateUserPoolDomain response output.
* @public */ export interface UpdateUserPoolDomainResponse { /** *A version number that indicates the state of managed login for your domain. Version
* 1 is hosted UI (classic). Version 2 is the newer managed
* login with the branding designer. For more information, see Managed login.
The fully-qualified domain name (FQDN) of the Amazon CloudFront distribution that hosts your
* managed login or classic hosted UI pages. You domain-name authority must have an alias
* record that points requests for your custom domain to this FQDN. 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.
This exception is thrown when there is a code mismatch and the service fails to * configure the software token TOTP multi-factor authentication (MFA).
* @public */ export declare class EnableSoftwareTokenMFAException extends __BaseException { readonly name: "EnableSoftwareTokenMFAException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeA valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
* aws.cognito.signin.user.admin.
The session ID from an AssociateSoftwareToken request.
A TOTP that the user generated in their configured authenticator app.
* @public */ UserCode: string | undefined; /** *A friendly name for the device that's running the TOTP authenticator.
* @public */ FriendlyDeviceName?: string | undefined; } /** * @public * @enum */ export declare const VerifySoftwareTokenResponseType: { readonly ERROR: "ERROR"; readonly SUCCESS: "SUCCESS"; }; /** * @public */ export type VerifySoftwareTokenResponseType = (typeof VerifySoftwareTokenResponseType)[keyof typeof VerifySoftwareTokenResponseType]; /** * @public */ export interface VerifySoftwareTokenResponse { /** *Amazon Cognito can accept or reject the code that you provide. This response parameter * indicates the success of TOTP verification. Some reasons that this operation might * return an error are clock skew on the user's device and excessive retries.
* @public */ Status?: VerifySoftwareTokenResponseType | undefined; /** *This session ID satisfies an MFA_SETUP challenge. Supply the session ID
* in your challenge response.
Represents the request to verify user attributes.
* @public */ export interface VerifyUserAttributeRequest { /** *A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
* aws.cognito.signin.user.admin.
The name of the attribute that you want to verify.
* @public */ AttributeName: string | undefined; /** *The verification code that your user pool sent to the added or changed attribute, for * example the user's email address.
* @public */ Code: string | undefined; } /** *A container representing the response from the server from the request to verify user * attributes.
* @public */ export interface VerifyUserAttributeResponse { } /** * @internal */ export declare const GetUserAuthFactorsRequestFilterSensitiveLog: (obj: GetUserAuthFactorsRequest) => any; /** * @internal */ export declare const GetUserAuthFactorsResponseFilterSensitiveLog: (obj: GetUserAuthFactorsResponse) => any; /** * @internal */ export declare const GlobalSignOutRequestFilterSensitiveLog: (obj: GlobalSignOutRequest) => any; /** * @internal */ export declare const InitiateAuthRequestFilterSensitiveLog: (obj: InitiateAuthRequest) => any; /** * @internal */ export declare const InitiateAuthResponseFilterSensitiveLog: (obj: InitiateAuthResponse) => any; /** * @internal */ export declare const ListDevicesRequestFilterSensitiveLog: (obj: ListDevicesRequest) => any; /** * @internal */ export declare const ListDevicesResponseFilterSensitiveLog: (obj: ListDevicesResponse) => any; /** * @internal */ export declare const UserPoolClientDescriptionFilterSensitiveLog: (obj: UserPoolClientDescription) => any; /** * @internal */ export declare const ListUserPoolClientsResponseFilterSensitiveLog: (obj: ListUserPoolClientsResponse) => any; /** * @internal */ export declare const ListUsersResponseFilterSensitiveLog: (obj: ListUsersResponse) => any; /** * @internal */ export declare const ListUsersInGroupResponseFilterSensitiveLog: (obj: ListUsersInGroupResponse) => any; /** * @internal */ export declare const ListWebAuthnCredentialsRequestFilterSensitiveLog: (obj: ListWebAuthnCredentialsRequest) => any; /** * @internal */ export declare const ResendConfirmationCodeRequestFilterSensitiveLog: (obj: ResendConfirmationCodeRequest) => any; /** * @internal */ export declare const RespondToAuthChallengeRequestFilterSensitiveLog: (obj: RespondToAuthChallengeRequest) => any; /** * @internal */ export declare const RespondToAuthChallengeResponseFilterSensitiveLog: (obj: RespondToAuthChallengeResponse) => any; /** * @internal */ export declare const RevokeTokenRequestFilterSensitiveLog: (obj: RevokeTokenRequest) => any; /** * @internal */ export declare const SetRiskConfigurationRequestFilterSensitiveLog: (obj: SetRiskConfigurationRequest) => any; /** * @internal */ export declare const SetRiskConfigurationResponseFilterSensitiveLog: (obj: SetRiskConfigurationResponse) => any; /** * @internal */ export declare const SetUICustomizationRequestFilterSensitiveLog: (obj: SetUICustomizationRequest) => any; /** * @internal */ export declare const SetUICustomizationResponseFilterSensitiveLog: (obj: SetUICustomizationResponse) => any; /** * @internal */ export declare const SetUserMFAPreferenceRequestFilterSensitiveLog: (obj: SetUserMFAPreferenceRequest) => any; /** * @internal */ export declare const SetUserSettingsRequestFilterSensitiveLog: (obj: SetUserSettingsRequest) => any; /** * @internal */ export declare const SignUpRequestFilterSensitiveLog: (obj: SignUpRequest) => any; /** * @internal */ export declare const SignUpResponseFilterSensitiveLog: (obj: SignUpResponse) => any; /** * @internal */ export declare const StartWebAuthnRegistrationRequestFilterSensitiveLog: (obj: StartWebAuthnRegistrationRequest) => any; /** * @internal */ export declare const UpdateAuthEventFeedbackRequestFilterSensitiveLog: (obj: UpdateAuthEventFeedbackRequest) => any; /** * @internal */ export declare const UpdateDeviceStatusRequestFilterSensitiveLog: (obj: UpdateDeviceStatusRequest) => any; /** * @internal */ export declare const UpdateUserAttributesRequestFilterSensitiveLog: (obj: UpdateUserAttributesRequest) => any; /** * @internal */ export declare const UpdateUserPoolClientRequestFilterSensitiveLog: (obj: UpdateUserPoolClientRequest) => any; /** * @internal */ export declare const UpdateUserPoolClientResponseFilterSensitiveLog: (obj: UpdateUserPoolClientResponse) => any; /** * @internal */ export declare const VerifySoftwareTokenRequestFilterSensitiveLog: (obj: VerifySoftwareTokenRequest) => any; /** * @internal */ export declare const VerifySoftwareTokenResponseFilterSensitiveLog: (obj: VerifySoftwareTokenResponse) => any; /** * @internal */ export declare const VerifyUserAttributeRequestFilterSensitiveLog: (obj: VerifyUserAttributeRequest) => any;