mypydantic.models.cognito_idp

   1# Model Generated: Thu Mar  2 21:56:17 2023
   2
   3from __future__ import annotations
   4
   5from datetime import datetime
   6from typing import (
   7    Any,
   8    Dict,
   9    IO,
  10    List,
  11    Literal,
  12    Mapping,
  13    Optional,
  14    Sequence,
  15    Type,
  16    Union,
  17)
  18
  19from botocore.response import StreamingBody
  20from pydantic import Field
  21
  22from mypydantic.models.base_model import BaseModel
  23
  24
  25class RecoveryOptionTypeModel(BaseModel):
  26    priority: int = Field(alias="Priority")
  27    name: Literal["admin_only", "verified_email", "verified_phone_number"] = Field(
  28        alias="Name"
  29    )
  30
  31
  32class AccountTakeoverActionTypeModel(BaseModel):
  33    notify: bool = Field(alias="Notify")
  34    event_action: Literal[
  35        "BLOCK", "MFA_IF_CONFIGURED", "MFA_REQUIRED", "NO_ACTION"
  36    ] = Field(alias="EventAction")
  37
  38
  39class AdminAddUserToGroupRequestModel(BaseModel):
  40    user_pool_id: str = Field(alias="UserPoolId")
  41    username: str = Field(alias="Username")
  42    group_name: str = Field(alias="GroupName")
  43
  44
  45class AdminConfirmSignUpRequestModel(BaseModel):
  46    user_pool_id: str = Field(alias="UserPoolId")
  47    username: str = Field(alias="Username")
  48    client_metadata: Optional[Mapping[str, str]] = Field(
  49        default=None, alias="ClientMetadata"
  50    )
  51
  52
  53class MessageTemplateTypeModel(BaseModel):
  54    s_ms_message: Optional[str] = Field(default=None, alias="SMSMessage")
  55    email_message: Optional[str] = Field(default=None, alias="EmailMessage")
  56    email_subject: Optional[str] = Field(default=None, alias="EmailSubject")
  57
  58
  59class AttributeTypeModel(BaseModel):
  60    name: str = Field(alias="Name")
  61    value: Optional[str] = Field(default=None, alias="Value")
  62
  63
  64class ResponseMetadataModel(BaseModel):
  65    request_id: str = Field(alias="RequestId")
  66    host_id: str = Field(alias="HostId")
  67    http_status_code: int = Field(alias="HTTPStatusCode")
  68    http_headers: Dict[str, str] = Field(alias="HTTPHeaders")
  69    retry_attempts: int = Field(alias="RetryAttempts")
  70
  71
  72class AdminDeleteUserAttributesRequestModel(BaseModel):
  73    user_pool_id: str = Field(alias="UserPoolId")
  74    username: str = Field(alias="Username")
  75    user_attribute_names: Sequence[str] = Field(alias="UserAttributeNames")
  76
  77
  78class AdminDeleteUserRequestModel(BaseModel):
  79    user_pool_id: str = Field(alias="UserPoolId")
  80    username: str = Field(alias="Username")
  81
  82
  83class ProviderUserIdentifierTypeModel(BaseModel):
  84    provider_name: Optional[str] = Field(default=None, alias="ProviderName")
  85    provider_attribute_name: Optional[str] = Field(
  86        default=None, alias="ProviderAttributeName"
  87    )
  88    provider_attribute_value: Optional[str] = Field(
  89        default=None, alias="ProviderAttributeValue"
  90    )
  91
  92
  93class AdminDisableUserRequestModel(BaseModel):
  94    user_pool_id: str = Field(alias="UserPoolId")
  95    username: str = Field(alias="Username")
  96
  97
  98class AdminEnableUserRequestModel(BaseModel):
  99    user_pool_id: str = Field(alias="UserPoolId")
 100    username: str = Field(alias="Username")
 101
 102
 103class AdminForgetDeviceRequestModel(BaseModel):
 104    user_pool_id: str = Field(alias="UserPoolId")
 105    username: str = Field(alias="Username")
 106    device_key: str = Field(alias="DeviceKey")
 107
 108
 109class AdminGetDeviceRequestModel(BaseModel):
 110    device_key: str = Field(alias="DeviceKey")
 111    user_pool_id: str = Field(alias="UserPoolId")
 112    username: str = Field(alias="Username")
 113
 114
 115class AdminGetUserRequestModel(BaseModel):
 116    user_pool_id: str = Field(alias="UserPoolId")
 117    username: str = Field(alias="Username")
 118
 119
 120class MFAOptionTypeModel(BaseModel):
 121    delivery_medium: Optional[Literal["EMAIL", "SMS"]] = Field(
 122        default=None, alias="DeliveryMedium"
 123    )
 124    attribute_name: Optional[str] = Field(default=None, alias="AttributeName")
 125
 126
 127class AnalyticsMetadataTypeModel(BaseModel):
 128    analytics_endpoint_id: Optional[str] = Field(
 129        default=None, alias="AnalyticsEndpointId"
 130    )
 131
 132
 133class AdminListDevicesRequestModel(BaseModel):
 134    user_pool_id: str = Field(alias="UserPoolId")
 135    username: str = Field(alias="Username")
 136    limit: Optional[int] = Field(default=None, alias="Limit")
 137    pagination_token: Optional[str] = Field(default=None, alias="PaginationToken")
 138
 139
 140class PaginatorConfigModel(BaseModel):
 141    max_items: Optional[int] = Field(default=None, alias="MaxItems")
 142    page_size: Optional[int] = Field(default=None, alias="PageSize")
 143    starting_token: Optional[str] = Field(default=None, alias="StartingToken")
 144
 145
 146class AdminListGroupsForUserRequestModel(BaseModel):
 147    username: str = Field(alias="Username")
 148    user_pool_id: str = Field(alias="UserPoolId")
 149    limit: Optional[int] = Field(default=None, alias="Limit")
 150    next_token: Optional[str] = Field(default=None, alias="NextToken")
 151
 152
 153class GroupTypeModel(BaseModel):
 154    group_name: Optional[str] = Field(default=None, alias="GroupName")
 155    user_pool_id: Optional[str] = Field(default=None, alias="UserPoolId")
 156    description: Optional[str] = Field(default=None, alias="Description")
 157    role_arn: Optional[str] = Field(default=None, alias="RoleArn")
 158    precedence: Optional[int] = Field(default=None, alias="Precedence")
 159    last_modified_date: Optional[datetime] = Field(
 160        default=None, alias="LastModifiedDate"
 161    )
 162    creation_date: Optional[datetime] = Field(default=None, alias="CreationDate")
 163
 164
 165class AdminListUserAuthEventsRequestModel(BaseModel):
 166    user_pool_id: str = Field(alias="UserPoolId")
 167    username: str = Field(alias="Username")
 168    max_results: Optional[int] = Field(default=None, alias="MaxResults")
 169    next_token: Optional[str] = Field(default=None, alias="NextToken")
 170
 171
 172class AdminRemoveUserFromGroupRequestModel(BaseModel):
 173    user_pool_id: str = Field(alias="UserPoolId")
 174    username: str = Field(alias="Username")
 175    group_name: str = Field(alias="GroupName")
 176
 177
 178class AdminResetUserPasswordRequestModel(BaseModel):
 179    user_pool_id: str = Field(alias="UserPoolId")
 180    username: str = Field(alias="Username")
 181    client_metadata: Optional[Mapping[str, str]] = Field(
 182        default=None, alias="ClientMetadata"
 183    )
 184
 185
 186class SMSMfaSettingsTypeModel(BaseModel):
 187    enabled: Optional[bool] = Field(default=None, alias="Enabled")
 188    preferred_mfa: Optional[bool] = Field(default=None, alias="PreferredMfa")
 189
 190
 191class SoftwareTokenMfaSettingsTypeModel(BaseModel):
 192    enabled: Optional[bool] = Field(default=None, alias="Enabled")
 193    preferred_mfa: Optional[bool] = Field(default=None, alias="PreferredMfa")
 194
 195
 196class AdminSetUserPasswordRequestModel(BaseModel):
 197    user_pool_id: str = Field(alias="UserPoolId")
 198    username: str = Field(alias="Username")
 199    password: str = Field(alias="Password")
 200    permanent: Optional[bool] = Field(default=None, alias="Permanent")
 201
 202
 203class AdminUpdateAuthEventFeedbackRequestModel(BaseModel):
 204    user_pool_id: str = Field(alias="UserPoolId")
 205    username: str = Field(alias="Username")
 206    event_id: str = Field(alias="EventId")
 207    feedback_value: Literal["Invalid", "Valid"] = Field(alias="FeedbackValue")
 208
 209
 210class AdminUpdateDeviceStatusRequestModel(BaseModel):
 211    user_pool_id: str = Field(alias="UserPoolId")
 212    username: str = Field(alias="Username")
 213    device_key: str = Field(alias="DeviceKey")
 214    device_remembered_status: Optional[Literal["not_remembered", "remembered"]] = Field(
 215        default=None, alias="DeviceRememberedStatus"
 216    )
 217
 218
 219class AdminUserGlobalSignOutRequestModel(BaseModel):
 220    user_pool_id: str = Field(alias="UserPoolId")
 221    username: str = Field(alias="Username")
 222
 223
 224class AnalyticsConfigurationTypeModel(BaseModel):
 225    application_id: Optional[str] = Field(default=None, alias="ApplicationId")
 226    application_arn: Optional[str] = Field(default=None, alias="ApplicationArn")
 227    role_arn: Optional[str] = Field(default=None, alias="RoleArn")
 228    external_id: Optional[str] = Field(default=None, alias="ExternalId")
 229    user_data_shared: Optional[bool] = Field(default=None, alias="UserDataShared")
 230
 231
 232class AssociateSoftwareTokenRequestModel(BaseModel):
 233    access_token: Optional[str] = Field(default=None, alias="AccessToken")
 234    session: Optional[str] = Field(default=None, alias="Session")
 235
 236
 237class ChallengeResponseTypeModel(BaseModel):
 238    challenge_name: Optional[Literal["Mfa", "Password"]] = Field(
 239        default=None, alias="ChallengeName"
 240    )
 241    challenge_response: Optional[Literal["Failure", "Success"]] = Field(
 242        default=None, alias="ChallengeResponse"
 243    )
 244
 245
 246class EventContextDataTypeModel(BaseModel):
 247    ip_address: Optional[str] = Field(default=None, alias="IpAddress")
 248    device_name: Optional[str] = Field(default=None, alias="DeviceName")
 249    timezone: Optional[str] = Field(default=None, alias="Timezone")
 250    city: Optional[str] = Field(default=None, alias="City")
 251    country: Optional[str] = Field(default=None, alias="Country")
 252
 253
 254class EventFeedbackTypeModel(BaseModel):
 255    feedback_value: Literal["Invalid", "Valid"] = Field(alias="FeedbackValue")
 256    provider: str = Field(alias="Provider")
 257    feedback_date: Optional[datetime] = Field(default=None, alias="FeedbackDate")
 258
 259
 260class EventRiskTypeModel(BaseModel):
 261    risk_decision: Optional[Literal["AccountTakeover", "Block", "NoRisk"]] = Field(
 262        default=None, alias="RiskDecision"
 263    )
 264    risk_level: Optional[Literal["High", "Low", "Medium"]] = Field(
 265        default=None, alias="RiskLevel"
 266    )
 267    compromised_credentials_detected: Optional[bool] = Field(
 268        default=None, alias="CompromisedCredentialsDetected"
 269    )
 270
 271
 272class NewDeviceMetadataTypeModel(BaseModel):
 273    device_key: Optional[str] = Field(default=None, alias="DeviceKey")
 274    device_group_key: Optional[str] = Field(default=None, alias="DeviceGroupKey")
 275
 276
 277class ChangePasswordRequestModel(BaseModel):
 278    previous_password: str = Field(alias="PreviousPassword")
 279    proposed_password: str = Field(alias="ProposedPassword")
 280    access_token: str = Field(alias="AccessToken")
 281
 282
 283class CodeDeliveryDetailsTypeModel(BaseModel):
 284    destination: Optional[str] = Field(default=None, alias="Destination")
 285    delivery_medium: Optional[Literal["EMAIL", "SMS"]] = Field(
 286        default=None, alias="DeliveryMedium"
 287    )
 288    attribute_name: Optional[str] = Field(default=None, alias="AttributeName")
 289
 290
 291class CompromisedCredentialsActionsTypeModel(BaseModel):
 292    event_action: Literal["BLOCK", "NO_ACTION"] = Field(alias="EventAction")
 293
 294
 295class DeviceSecretVerifierConfigTypeModel(BaseModel):
 296    password_verifier: Optional[str] = Field(default=None, alias="PasswordVerifier")
 297    salt: Optional[str] = Field(default=None, alias="Salt")
 298
 299
 300class UserContextDataTypeModel(BaseModel):
 301    ip_address: Optional[str] = Field(default=None, alias="IpAddress")
 302    encoded_data: Optional[str] = Field(default=None, alias="EncodedData")
 303
 304
 305class HttpHeaderModel(BaseModel):
 306    header_name: Optional[str] = Field(default=None, alias="headerName")
 307    header_value: Optional[str] = Field(default=None, alias="headerValue")
 308
 309
 310class CreateGroupRequestModel(BaseModel):
 311    group_name: str = Field(alias="GroupName")
 312    user_pool_id: str = Field(alias="UserPoolId")
 313    description: Optional[str] = Field(default=None, alias="Description")
 314    role_arn: Optional[str] = Field(default=None, alias="RoleArn")
 315    precedence: Optional[int] = Field(default=None, alias="Precedence")
 316
 317
 318class CreateIdentityProviderRequestModel(BaseModel):
 319    user_pool_id: str = Field(alias="UserPoolId")
 320    provider_name: str = Field(alias="ProviderName")
 321    provider_type: Literal[
 322        "Facebook", "Google", "LoginWithAmazon", "OIDC", "SAML", "SignInWithApple"
 323    ] = Field(alias="ProviderType")
 324    provider_details: Mapping[str, str] = Field(alias="ProviderDetails")
 325    attribute_mapping: Optional[Mapping[str, str]] = Field(
 326        default=None, alias="AttributeMapping"
 327    )
 328    idp_identifiers: Optional[Sequence[str]] = Field(
 329        default=None, alias="IdpIdentifiers"
 330    )
 331
 332
 333class IdentityProviderTypeModel(BaseModel):
 334    user_pool_id: Optional[str] = Field(default=None, alias="UserPoolId")
 335    provider_name: Optional[str] = Field(default=None, alias="ProviderName")
 336    provider_type: Optional[
 337        Literal[
 338            "Facebook", "Google", "LoginWithAmazon", "OIDC", "SAML", "SignInWithApple"
 339        ]
 340    ] = Field(default=None, alias="ProviderType")
 341    provider_details: Optional[Dict[str, str]] = Field(
 342        default=None, alias="ProviderDetails"
 343    )
 344    attribute_mapping: Optional[Dict[str, str]] = Field(
 345        default=None, alias="AttributeMapping"
 346    )
 347    idp_identifiers: Optional[List[str]] = Field(default=None, alias="IdpIdentifiers")
 348    last_modified_date: Optional[datetime] = Field(
 349        default=None, alias="LastModifiedDate"
 350    )
 351    creation_date: Optional[datetime] = Field(default=None, alias="CreationDate")
 352
 353
 354class ResourceServerScopeTypeModel(BaseModel):
 355    scope_name: str = Field(alias="ScopeName")
 356    scope_description: str = Field(alias="ScopeDescription")
 357
 358
 359class CreateUserImportJobRequestModel(BaseModel):
 360    job_name: str = Field(alias="JobName")
 361    user_pool_id: str = Field(alias="UserPoolId")
 362    cloud_watch_logs_role_arn: str = Field(alias="CloudWatchLogsRoleArn")
 363
 364
 365class UserImportJobTypeModel(BaseModel):
 366    job_name: Optional[str] = Field(default=None, alias="JobName")
 367    job_id: Optional[str] = Field(default=None, alias="JobId")
 368    user_pool_id: Optional[str] = Field(default=None, alias="UserPoolId")
 369    pre_signed_url: Optional[str] = Field(default=None, alias="PreSignedUrl")
 370    creation_date: Optional[datetime] = Field(default=None, alias="CreationDate")
 371    start_date: Optional[datetime] = Field(default=None, alias="StartDate")
 372    completion_date: Optional[datetime] = Field(default=None, alias="CompletionDate")
 373    status: Optional[
 374        Literal[
 375            "Created",
 376            "Expired",
 377            "Failed",
 378            "InProgress",
 379            "Pending",
 380            "Stopped",
 381            "Stopping",
 382            "Succeeded",
 383        ]
 384    ] = Field(default=None, alias="Status")
 385    cloud_watch_logs_role_arn: Optional[str] = Field(
 386        default=None, alias="CloudWatchLogsRoleArn"
 387    )
 388    imported_users: Optional[int] = Field(default=None, alias="ImportedUsers")
 389    skipped_users: Optional[int] = Field(default=None, alias="SkippedUsers")
 390    failed_users: Optional[int] = Field(default=None, alias="FailedUsers")
 391    completion_message: Optional[str] = Field(default=None, alias="CompletionMessage")
 392
 393
 394class TokenValidityUnitsTypeModel(BaseModel):
 395    access_token: Optional[Literal["days", "hours", "minutes", "seconds"]] = Field(
 396        default=None, alias="AccessToken"
 397    )
 398    id_token: Optional[Literal["days", "hours", "minutes", "seconds"]] = Field(
 399        default=None, alias="IdToken"
 400    )
 401    refresh_token: Optional[Literal["days", "hours", "minutes", "seconds"]] = Field(
 402        default=None, alias="RefreshToken"
 403    )
 404
 405
 406class CustomDomainConfigTypeModel(BaseModel):
 407    certificate_arn: str = Field(alias="CertificateArn")
 408
 409
 410class DeviceConfigurationTypeModel(BaseModel):
 411    challenge_required_on_new_device: Optional[bool] = Field(
 412        default=None, alias="ChallengeRequiredOnNewDevice"
 413    )
 414    device_only_remembered_on_user_prompt: Optional[bool] = Field(
 415        default=None, alias="DeviceOnlyRememberedOnUserPrompt"
 416    )
 417
 418
 419class EmailConfigurationTypeModel(BaseModel):
 420    source_arn: Optional[str] = Field(default=None, alias="SourceArn")
 421    reply_to_email_address: Optional[str] = Field(
 422        default=None, alias="ReplyToEmailAddress"
 423    )
 424    email_sending_account: Optional[Literal["COGNITO_DEFAULT", "DEVELOPER"]] = Field(
 425        default=None, alias="EmailSendingAccount"
 426    )
 427    from_: Optional[str] = Field(default=None, alias="From")
 428    configuration_set: Optional[str] = Field(default=None, alias="ConfigurationSet")
 429
 430
 431class SmsConfigurationTypeModel(BaseModel):
 432    sns_caller_arn: str = Field(alias="SnsCallerArn")
 433    external_id: Optional[str] = Field(default=None, alias="ExternalId")
 434    sns_region: Optional[str] = Field(default=None, alias="SnsRegion")
 435
 436
 437class UserAttributeUpdateSettingsTypeModel(BaseModel):
 438    attributes_require_verification_before_update: Optional[
 439        Sequence[Literal["email", "phone_number"]]
 440    ] = Field(default=None, alias="AttributesRequireVerificationBeforeUpdate")
 441
 442
 443class UserPoolAddOnsTypeModel(BaseModel):
 444    advanced_security_mode: Literal["AUDIT", "ENFORCED", "OFF"] = Field(
 445        alias="AdvancedSecurityMode"
 446    )
 447
 448
 449class UsernameConfigurationTypeModel(BaseModel):
 450    case_sensitive: bool = Field(alias="CaseSensitive")
 451
 452
 453class VerificationMessageTemplateTypeModel(BaseModel):
 454    sms_message: Optional[str] = Field(default=None, alias="SmsMessage")
 455    email_message: Optional[str] = Field(default=None, alias="EmailMessage")
 456    email_subject: Optional[str] = Field(default=None, alias="EmailSubject")
 457    email_message_by_link: Optional[str] = Field(
 458        default=None, alias="EmailMessageByLink"
 459    )
 460    email_subject_by_link: Optional[str] = Field(
 461        default=None, alias="EmailSubjectByLink"
 462    )
 463    default_email_option: Optional[
 464        Literal["CONFIRM_WITH_CODE", "CONFIRM_WITH_LINK"]
 465    ] = Field(default=None, alias="DefaultEmailOption")
 466
 467
 468class CustomEmailLambdaVersionConfigTypeModel(BaseModel):
 469    lambda_version: Literal["V1_0"] = Field(alias="LambdaVersion")
 470    lambda_arn: str = Field(alias="LambdaArn")
 471
 472
 473class CustomSMSLambdaVersionConfigTypeModel(BaseModel):
 474    lambda_version: Literal["V1_0"] = Field(alias="LambdaVersion")
 475    lambda_arn: str = Field(alias="LambdaArn")
 476
 477
 478class DeleteGroupRequestModel(BaseModel):
 479    group_name: str = Field(alias="GroupName")
 480    user_pool_id: str = Field(alias="UserPoolId")
 481
 482
 483class DeleteIdentityProviderRequestModel(BaseModel):
 484    user_pool_id: str = Field(alias="UserPoolId")
 485    provider_name: str = Field(alias="ProviderName")
 486
 487
 488class DeleteResourceServerRequestModel(BaseModel):
 489    user_pool_id: str = Field(alias="UserPoolId")
 490    identifier: str = Field(alias="Identifier")
 491
 492
 493class DeleteUserAttributesRequestModel(BaseModel):
 494    user_attribute_names: Sequence[str] = Field(alias="UserAttributeNames")
 495    access_token: str = Field(alias="AccessToken")
 496
 497
 498class DeleteUserPoolClientRequestModel(BaseModel):
 499    user_pool_id: str = Field(alias="UserPoolId")
 500    client_id: str = Field(alias="ClientId")
 501
 502
 503class DeleteUserPoolDomainRequestModel(BaseModel):
 504    domain: str = Field(alias="Domain")
 505    user_pool_id: str = Field(alias="UserPoolId")
 506
 507
 508class DeleteUserPoolRequestModel(BaseModel):
 509    user_pool_id: str = Field(alias="UserPoolId")
 510
 511
 512class DeleteUserRequestModel(BaseModel):
 513    access_token: str = Field(alias="AccessToken")
 514
 515
 516class DescribeIdentityProviderRequestModel(BaseModel):
 517    user_pool_id: str = Field(alias="UserPoolId")
 518    provider_name: str = Field(alias="ProviderName")
 519
 520
 521class DescribeResourceServerRequestModel(BaseModel):
 522    user_pool_id: str = Field(alias="UserPoolId")
 523    identifier: str = Field(alias="Identifier")
 524
 525
 526class DescribeRiskConfigurationRequestModel(BaseModel):
 527    user_pool_id: str = Field(alias="UserPoolId")
 528    client_id: Optional[str] = Field(default=None, alias="ClientId")
 529
 530
 531class DescribeUserImportJobRequestModel(BaseModel):
 532    user_pool_id: str = Field(alias="UserPoolId")
 533    job_id: str = Field(alias="JobId")
 534
 535
 536class DescribeUserPoolClientRequestModel(BaseModel):
 537    user_pool_id: str = Field(alias="UserPoolId")
 538    client_id: str = Field(alias="ClientId")
 539
 540
 541class DescribeUserPoolDomainRequestModel(BaseModel):
 542    domain: str = Field(alias="Domain")
 543
 544
 545class DescribeUserPoolRequestModel(BaseModel):
 546    user_pool_id: str = Field(alias="UserPoolId")
 547
 548
 549class ForgetDeviceRequestModel(BaseModel):
 550    device_key: str = Field(alias="DeviceKey")
 551    access_token: Optional[str] = Field(default=None, alias="AccessToken")
 552
 553
 554class GetCSVHeaderRequestModel(BaseModel):
 555    user_pool_id: str = Field(alias="UserPoolId")
 556
 557
 558class GetDeviceRequestModel(BaseModel):
 559    device_key: str = Field(alias="DeviceKey")
 560    access_token: Optional[str] = Field(default=None, alias="AccessToken")
 561
 562
 563class GetGroupRequestModel(BaseModel):
 564    group_name: str = Field(alias="GroupName")
 565    user_pool_id: str = Field(alias="UserPoolId")
 566
 567
 568class GetIdentityProviderByIdentifierRequestModel(BaseModel):
 569    user_pool_id: str = Field(alias="UserPoolId")
 570    idp_identifier: str = Field(alias="IdpIdentifier")
 571
 572
 573class GetSigningCertificateRequestModel(BaseModel):
 574    user_pool_id: str = Field(alias="UserPoolId")
 575
 576
 577class GetUICustomizationRequestModel(BaseModel):
 578    user_pool_id: str = Field(alias="UserPoolId")
 579    client_id: Optional[str] = Field(default=None, alias="ClientId")
 580
 581
 582class UICustomizationTypeModel(BaseModel):
 583    user_pool_id: Optional[str] = Field(default=None, alias="UserPoolId")
 584    client_id: Optional[str] = Field(default=None, alias="ClientId")
 585    image_url: Optional[str] = Field(default=None, alias="ImageUrl")
 586    cs_s: Optional[str] = Field(default=None, alias="CSS")
 587    cs_s_version: Optional[str] = Field(default=None, alias="CSSVersion")
 588    last_modified_date: Optional[datetime] = Field(
 589        default=None, alias="LastModifiedDate"
 590    )
 591    creation_date: Optional[datetime] = Field(default=None, alias="CreationDate")
 592
 593
 594class GetUserAttributeVerificationCodeRequestModel(BaseModel):
 595    access_token: str = Field(alias="AccessToken")
 596    attribute_name: str = Field(alias="AttributeName")
 597    client_metadata: Optional[Mapping[str, str]] = Field(
 598        default=None, alias="ClientMetadata"
 599    )
 600
 601
 602class GetUserPoolMfaConfigRequestModel(BaseModel):
 603    user_pool_id: str = Field(alias="UserPoolId")
 604
 605
 606class SoftwareTokenMfaConfigTypeModel(BaseModel):
 607    enabled: Optional[bool] = Field(default=None, alias="Enabled")
 608
 609
 610class GetUserRequestModel(BaseModel):
 611    access_token: str = Field(alias="AccessToken")
 612
 613
 614class GlobalSignOutRequestModel(BaseModel):
 615    access_token: str = Field(alias="AccessToken")
 616
 617
 618class ListDevicesRequestModel(BaseModel):
 619    access_token: str = Field(alias="AccessToken")
 620    limit: Optional[int] = Field(default=None, alias="Limit")
 621    pagination_token: Optional[str] = Field(default=None, alias="PaginationToken")
 622
 623
 624class ListGroupsRequestModel(BaseModel):
 625    user_pool_id: str = Field(alias="UserPoolId")
 626    limit: Optional[int] = Field(default=None, alias="Limit")
 627    next_token: Optional[str] = Field(default=None, alias="NextToken")
 628
 629
 630class ListIdentityProvidersRequestModel(BaseModel):
 631    user_pool_id: str = Field(alias="UserPoolId")
 632    max_results: Optional[int] = Field(default=None, alias="MaxResults")
 633    next_token: Optional[str] = Field(default=None, alias="NextToken")
 634
 635
 636class ProviderDescriptionModel(BaseModel):
 637    provider_name: Optional[str] = Field(default=None, alias="ProviderName")
 638    provider_type: Optional[
 639        Literal[
 640            "Facebook", "Google", "LoginWithAmazon", "OIDC", "SAML", "SignInWithApple"
 641        ]
 642    ] = Field(default=None, alias="ProviderType")
 643    last_modified_date: Optional[datetime] = Field(
 644        default=None, alias="LastModifiedDate"
 645    )
 646    creation_date: Optional[datetime] = Field(default=None, alias="CreationDate")
 647
 648
 649class ListResourceServersRequestModel(BaseModel):
 650    user_pool_id: str = Field(alias="UserPoolId")
 651    max_results: Optional[int] = Field(default=None, alias="MaxResults")
 652    next_token: Optional[str] = Field(default=None, alias="NextToken")
 653
 654
 655class ListTagsForResourceRequestModel(BaseModel):
 656    resource_arn: str = Field(alias="ResourceArn")
 657
 658
 659class ListUserImportJobsRequestModel(BaseModel):
 660    user_pool_id: str = Field(alias="UserPoolId")
 661    max_results: int = Field(alias="MaxResults")
 662    pagination_token: Optional[str] = Field(default=None, alias="PaginationToken")
 663
 664
 665class ListUserPoolClientsRequestModel(BaseModel):
 666    user_pool_id: str = Field(alias="UserPoolId")
 667    max_results: Optional[int] = Field(default=None, alias="MaxResults")
 668    next_token: Optional[str] = Field(default=None, alias="NextToken")
 669
 670
 671class UserPoolClientDescriptionModel(BaseModel):
 672    client_id: Optional[str] = Field(default=None, alias="ClientId")
 673    user_pool_id: Optional[str] = Field(default=None, alias="UserPoolId")
 674    client_name: Optional[str] = Field(default=None, alias="ClientName")
 675
 676
 677class ListUserPoolsRequestModel(BaseModel):
 678    max_results: int = Field(alias="MaxResults")
 679    next_token: Optional[str] = Field(default=None, alias="NextToken")
 680
 681
 682class ListUsersInGroupRequestModel(BaseModel):
 683    user_pool_id: str = Field(alias="UserPoolId")
 684    group_name: str = Field(alias="GroupName")
 685    limit: Optional[int] = Field(default=None, alias="Limit")
 686    next_token: Optional[str] = Field(default=None, alias="NextToken")
 687
 688
 689class ListUsersRequestModel(BaseModel):
 690    user_pool_id: str = Field(alias="UserPoolId")
 691    attributes_to_get: Optional[Sequence[str]] = Field(
 692        default=None, alias="AttributesToGet"
 693    )
 694    limit: Optional[int] = Field(default=None, alias="Limit")
 695    pagination_token: Optional[str] = Field(default=None, alias="PaginationToken")
 696    filter: Optional[str] = Field(default=None, alias="Filter")
 697
 698
 699class NotifyEmailTypeModel(BaseModel):
 700    subject: str = Field(alias="Subject")
 701    html_body: Optional[str] = Field(default=None, alias="HtmlBody")
 702    text_body: Optional[str] = Field(default=None, alias="TextBody")
 703
 704
 705class NumberAttributeConstraintsTypeModel(BaseModel):
 706    min_value: Optional[str] = Field(default=None, alias="MinValue")
 707    max_value: Optional[str] = Field(default=None, alias="MaxValue")
 708
 709
 710class PasswordPolicyTypeModel(BaseModel):
 711    minimum_length: Optional[int] = Field(default=None, alias="MinimumLength")
 712    require_uppercase: Optional[bool] = Field(default=None, alias="RequireUppercase")
 713    require_lowercase: Optional[bool] = Field(default=None, alias="RequireLowercase")
 714    require_numbers: Optional[bool] = Field(default=None, alias="RequireNumbers")
 715    require_symbols: Optional[bool] = Field(default=None, alias="RequireSymbols")
 716    temporary_password_validity_days: Optional[int] = Field(
 717        default=None, alias="TemporaryPasswordValidityDays"
 718    )
 719
 720
 721class RevokeTokenRequestModel(BaseModel):
 722    token: str = Field(alias="Token")
 723    client_id: str = Field(alias="ClientId")
 724    client_secret: Optional[str] = Field(default=None, alias="ClientSecret")
 725
 726
 727class RiskExceptionConfigurationTypeModel(BaseModel):
 728    blocked_ip_range_list: Optional[List[str]] = Field(
 729        default=None, alias="BlockedIPRangeList"
 730    )
 731    skipped_ip_range_list: Optional[List[str]] = Field(
 732        default=None, alias="SkippedIPRangeList"
 733    )
 734
 735
 736class StringAttributeConstraintsTypeModel(BaseModel):
 737    min_length: Optional[str] = Field(default=None, alias="MinLength")
 738    max_length: Optional[str] = Field(default=None, alias="MaxLength")
 739
 740
 741class SetUICustomizationRequestModel(BaseModel):
 742    user_pool_id: str = Field(alias="UserPoolId")
 743    client_id: Optional[str] = Field(default=None, alias="ClientId")
 744    cs_s: Optional[str] = Field(default=None, alias="CSS")
 745    image_file: Optional[Union[str, bytes, Type[IO[Any]], Type[StreamingBody]]] = Field(
 746        default=None, alias="ImageFile"
 747    )
 748
 749
 750class StartUserImportJobRequestModel(BaseModel):
 751    user_pool_id: str = Field(alias="UserPoolId")
 752    job_id: str = Field(alias="JobId")
 753
 754
 755class StopUserImportJobRequestModel(BaseModel):
 756    user_pool_id: str = Field(alias="UserPoolId")
 757    job_id: str = Field(alias="JobId")
 758
 759
 760class TagResourceRequestModel(BaseModel):
 761    resource_arn: str = Field(alias="ResourceArn")
 762    tags: Mapping[str, str] = Field(alias="Tags")
 763
 764
 765class UntagResourceRequestModel(BaseModel):
 766    resource_arn: str = Field(alias="ResourceArn")
 767    tag_keys: Sequence[str] = Field(alias="TagKeys")
 768
 769
 770class UpdateAuthEventFeedbackRequestModel(BaseModel):
 771    user_pool_id: str = Field(alias="UserPoolId")
 772    username: str = Field(alias="Username")
 773    event_id: str = Field(alias="EventId")
 774    feedback_token: str = Field(alias="FeedbackToken")
 775    feedback_value: Literal["Invalid", "Valid"] = Field(alias="FeedbackValue")
 776
 777
 778class UpdateDeviceStatusRequestModel(BaseModel):
 779    access_token: str = Field(alias="AccessToken")
 780    device_key: str = Field(alias="DeviceKey")
 781    device_remembered_status: Optional[Literal["not_remembered", "remembered"]] = Field(
 782        default=None, alias="DeviceRememberedStatus"
 783    )
 784
 785
 786class UpdateGroupRequestModel(BaseModel):
 787    group_name: str = Field(alias="GroupName")
 788    user_pool_id: str = Field(alias="UserPoolId")
 789    description: Optional[str] = Field(default=None, alias="Description")
 790    role_arn: Optional[str] = Field(default=None, alias="RoleArn")
 791    precedence: Optional[int] = Field(default=None, alias="Precedence")
 792
 793
 794class UpdateIdentityProviderRequestModel(BaseModel):
 795    user_pool_id: str = Field(alias="UserPoolId")
 796    provider_name: str = Field(alias="ProviderName")
 797    provider_details: Optional[Mapping[str, str]] = Field(
 798        default=None, alias="ProviderDetails"
 799    )
 800    attribute_mapping: Optional[Mapping[str, str]] = Field(
 801        default=None, alias="AttributeMapping"
 802    )
 803    idp_identifiers: Optional[Sequence[str]] = Field(
 804        default=None, alias="IdpIdentifiers"
 805    )
 806
 807
 808class VerifySoftwareTokenRequestModel(BaseModel):
 809    user_code: str = Field(alias="UserCode")
 810    access_token: Optional[str] = Field(default=None, alias="AccessToken")
 811    session: Optional[str] = Field(default=None, alias="Session")
 812    friendly_device_name: Optional[str] = Field(
 813        default=None, alias="FriendlyDeviceName"
 814    )
 815
 816
 817class VerifyUserAttributeRequestModel(BaseModel):
 818    access_token: str = Field(alias="AccessToken")
 819    attribute_name: str = Field(alias="AttributeName")
 820    code: str = Field(alias="Code")
 821
 822
 823class AccountRecoverySettingTypeModel(BaseModel):
 824    recovery_mechanisms: Optional[Sequence[RecoveryOptionTypeModel]] = Field(
 825        default=None, alias="RecoveryMechanisms"
 826    )
 827
 828
 829class AccountTakeoverActionsTypeModel(BaseModel):
 830    low_action: Optional[AccountTakeoverActionTypeModel] = Field(
 831        default=None, alias="LowAction"
 832    )
 833    medium_action: Optional[AccountTakeoverActionTypeModel] = Field(
 834        default=None, alias="MediumAction"
 835    )
 836    high_action: Optional[AccountTakeoverActionTypeModel] = Field(
 837        default=None, alias="HighAction"
 838    )
 839
 840
 841class AdminCreateUserConfigTypeModel(BaseModel):
 842    allow_admin_create_user_only: Optional[bool] = Field(
 843        default=None, alias="AllowAdminCreateUserOnly"
 844    )
 845    unused_account_validity_days: Optional[int] = Field(
 846        default=None, alias="UnusedAccountValidityDays"
 847    )
 848    invite_message_template: Optional[MessageTemplateTypeModel] = Field(
 849        default=None, alias="InviteMessageTemplate"
 850    )
 851
 852
 853class AdminCreateUserRequestModel(BaseModel):
 854    user_pool_id: str = Field(alias="UserPoolId")
 855    username: str = Field(alias="Username")
 856    user_attributes: Optional[Sequence[AttributeTypeModel]] = Field(
 857        default=None, alias="UserAttributes"
 858    )
 859    validation_data: Optional[Sequence[AttributeTypeModel]] = Field(
 860        default=None, alias="ValidationData"
 861    )
 862    temporary_password: Optional[str] = Field(default=None, alias="TemporaryPassword")
 863    force_alias_creation: Optional[bool] = Field(
 864        default=None, alias="ForceAliasCreation"
 865    )
 866    message_action: Optional[Literal["RESEND", "SUPPRESS"]] = Field(
 867        default=None, alias="MessageAction"
 868    )
 869    desired_delivery_mediums: Optional[Sequence[Literal["EMAIL", "SMS"]]] = Field(
 870        default=None, alias="DesiredDeliveryMediums"
 871    )
 872    client_metadata: Optional[Mapping[str, str]] = Field(
 873        default=None, alias="ClientMetadata"
 874    )
 875
 876
 877class AdminUpdateUserAttributesRequestModel(BaseModel):
 878    user_pool_id: str = Field(alias="UserPoolId")
 879    username: str = Field(alias="Username")
 880    user_attributes: Sequence[AttributeTypeModel] = Field(alias="UserAttributes")
 881    client_metadata: Optional[Mapping[str, str]] = Field(
 882        default=None, alias="ClientMetadata"
 883    )
 884
 885
 886class DeviceTypeModel(BaseModel):
 887    device_key: Optional[str] = Field(default=None, alias="DeviceKey")
 888    device_attributes: Optional[List[AttributeTypeModel]] = Field(
 889        default=None, alias="DeviceAttributes"
 890    )
 891    device_create_date: Optional[datetime] = Field(
 892        default=None, alias="DeviceCreateDate"
 893    )
 894    device_last_modified_date: Optional[datetime] = Field(
 895        default=None, alias="DeviceLastModifiedDate"
 896    )
 897    device_last_authenticated_date: Optional[datetime] = Field(
 898        default=None, alias="DeviceLastAuthenticatedDate"
 899    )
 900
 901
 902class UpdateUserAttributesRequestModel(BaseModel):
 903    user_attributes: Sequence[AttributeTypeModel] = Field(alias="UserAttributes")
 904    access_token: str = Field(alias="AccessToken")
 905    client_metadata: Optional[Mapping[str, str]] = Field(
 906        default=None, alias="ClientMetadata"
 907    )
 908
 909
 910class AssociateSoftwareTokenResponseModel(BaseModel):
 911    secret_code: str = Field(alias="SecretCode")
 912    session: str = Field(alias="Session")
 913    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
 914
 915
 916class ConfirmDeviceResponseModel(BaseModel):
 917    user_confirmation_necessary: bool = Field(alias="UserConfirmationNecessary")
 918    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
 919
 920
 921class CreateUserPoolDomainResponseModel(BaseModel):
 922    cloud_front_domain: str = Field(alias="CloudFrontDomain")
 923    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
 924
 925
 926class EmptyResponseMetadataModel(BaseModel):
 927    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
 928
 929
 930class GetCSVHeaderResponseModel(BaseModel):
 931    user_pool_id: str = Field(alias="UserPoolId")
 932    cs_vheader: List[str] = Field(alias="CSVHeader")
 933    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
 934
 935
 936class GetSigningCertificateResponseModel(BaseModel):
 937    certificate: str = Field(alias="Certificate")
 938    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
 939
 940
 941class ListTagsForResourceResponseModel(BaseModel):
 942    tags: Dict[str, str] = Field(alias="Tags")
 943    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
 944
 945
 946class UpdateUserPoolDomainResponseModel(BaseModel):
 947    cloud_front_domain: str = Field(alias="CloudFrontDomain")
 948    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
 949
 950
 951class VerifySoftwareTokenResponseModel(BaseModel):
 952    status: Literal["ERROR", "SUCCESS"] = Field(alias="Status")
 953    session: str = Field(alias="Session")
 954    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
 955
 956
 957class AdminDisableProviderForUserRequestModel(BaseModel):
 958    user_pool_id: str = Field(alias="UserPoolId")
 959    user: ProviderUserIdentifierTypeModel = Field(alias="User")
 960
 961
 962class AdminLinkProviderForUserRequestModel(BaseModel):
 963    user_pool_id: str = Field(alias="UserPoolId")
 964    destination_user: ProviderUserIdentifierTypeModel = Field(alias="DestinationUser")
 965    source_user: ProviderUserIdentifierTypeModel = Field(alias="SourceUser")
 966
 967
 968class AdminGetUserResponseModel(BaseModel):
 969    username: str = Field(alias="Username")
 970    user_attributes: List[AttributeTypeModel] = Field(alias="UserAttributes")
 971    user_create_date: datetime = Field(alias="UserCreateDate")
 972    user_last_modified_date: datetime = Field(alias="UserLastModifiedDate")
 973    enabled: bool = Field(alias="Enabled")
 974    user_status: Literal[
 975        "ARCHIVED",
 976        "COMPROMISED",
 977        "CONFIRMED",
 978        "FORCE_CHANGE_PASSWORD",
 979        "RESET_REQUIRED",
 980        "UNCONFIRMED",
 981        "UNKNOWN",
 982    ] = Field(alias="UserStatus")
 983    mfaoptions: List[MFAOptionTypeModel] = Field(alias="MFAOptions")
 984    preferred_mfa_setting: str = Field(alias="PreferredMfaSetting")
 985    user_mfasetting_list: List[str] = Field(alias="UserMFASettingList")
 986    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
 987
 988
 989class AdminSetUserSettingsRequestModel(BaseModel):
 990    user_pool_id: str = Field(alias="UserPoolId")
 991    username: str = Field(alias="Username")
 992    mfaoptions: Sequence[MFAOptionTypeModel] = Field(alias="MFAOptions")
 993
 994
 995class GetUserResponseModel(BaseModel):
 996    username: str = Field(alias="Username")
 997    user_attributes: List[AttributeTypeModel] = Field(alias="UserAttributes")
 998    mfaoptions: List[MFAOptionTypeModel] = Field(alias="MFAOptions")
 999    preferred_mfa_setting: str = Field(alias="PreferredMfaSetting")
1000    user_mfasetting_list: List[str] = Field(alias="UserMFASettingList")
1001    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1002
1003
1004class SetUserSettingsRequestModel(BaseModel):
1005    access_token: str = Field(alias="AccessToken")
1006    mfaoptions: Sequence[MFAOptionTypeModel] = Field(alias="MFAOptions")
1007
1008
1009class UserTypeModel(BaseModel):
1010    username: Optional[str] = Field(default=None, alias="Username")
1011    attributes: Optional[List[AttributeTypeModel]] = Field(
1012        default=None, alias="Attributes"
1013    )
1014    user_create_date: Optional[datetime] = Field(default=None, alias="UserCreateDate")
1015    user_last_modified_date: Optional[datetime] = Field(
1016        default=None, alias="UserLastModifiedDate"
1017    )
1018    enabled: Optional[bool] = Field(default=None, alias="Enabled")
1019    user_status: Optional[
1020        Literal[
1021            "ARCHIVED",
1022            "COMPROMISED",
1023            "CONFIRMED",
1024            "FORCE_CHANGE_PASSWORD",
1025            "RESET_REQUIRED",
1026            "UNCONFIRMED",
1027            "UNKNOWN",
1028        ]
1029    ] = Field(default=None, alias="UserStatus")
1030    mfaoptions: Optional[List[MFAOptionTypeModel]] = Field(
1031        default=None, alias="MFAOptions"
1032    )
1033
1034
1035class AdminListGroupsForUserRequestAdminListGroupsForUserPaginateModel(BaseModel):
1036    username: str = Field(alias="Username")
1037    user_pool_id: str = Field(alias="UserPoolId")
1038    pagination_config: Optional[PaginatorConfigModel] = Field(
1039        default=None, alias="PaginationConfig"
1040    )
1041
1042
1043class AdminListUserAuthEventsRequestAdminListUserAuthEventsPaginateModel(BaseModel):
1044    user_pool_id: str = Field(alias="UserPoolId")
1045    username: str = Field(alias="Username")
1046    pagination_config: Optional[PaginatorConfigModel] = Field(
1047        default=None, alias="PaginationConfig"
1048    )
1049
1050
1051class ListGroupsRequestListGroupsPaginateModel(BaseModel):
1052    user_pool_id: str = Field(alias="UserPoolId")
1053    pagination_config: Optional[PaginatorConfigModel] = Field(
1054        default=None, alias="PaginationConfig"
1055    )
1056
1057
1058class ListIdentityProvidersRequestListIdentityProvidersPaginateModel(BaseModel):
1059    user_pool_id: str = Field(alias="UserPoolId")
1060    pagination_config: Optional[PaginatorConfigModel] = Field(
1061        default=None, alias="PaginationConfig"
1062    )
1063
1064
1065class ListResourceServersRequestListResourceServersPaginateModel(BaseModel):
1066    user_pool_id: str = Field(alias="UserPoolId")
1067    pagination_config: Optional[PaginatorConfigModel] = Field(
1068        default=None, alias="PaginationConfig"
1069    )
1070
1071
1072class ListUserPoolClientsRequestListUserPoolClientsPaginateModel(BaseModel):
1073    user_pool_id: str = Field(alias="UserPoolId")
1074    pagination_config: Optional[PaginatorConfigModel] = Field(
1075        default=None, alias="PaginationConfig"
1076    )
1077
1078
1079class ListUserPoolsRequestListUserPoolsPaginateModel(BaseModel):
1080    pagination_config: Optional[PaginatorConfigModel] = Field(
1081        default=None, alias="PaginationConfig"
1082    )
1083
1084
1085class ListUsersInGroupRequestListUsersInGroupPaginateModel(BaseModel):
1086    user_pool_id: str = Field(alias="UserPoolId")
1087    group_name: str = Field(alias="GroupName")
1088    pagination_config: Optional[PaginatorConfigModel] = Field(
1089        default=None, alias="PaginationConfig"
1090    )
1091
1092
1093class ListUsersRequestListUsersPaginateModel(BaseModel):
1094    user_pool_id: str = Field(alias="UserPoolId")
1095    attributes_to_get: Optional[Sequence[str]] = Field(
1096        default=None, alias="AttributesToGet"
1097    )
1098    filter: Optional[str] = Field(default=None, alias="Filter")
1099    pagination_config: Optional[PaginatorConfigModel] = Field(
1100        default=None, alias="PaginationConfig"
1101    )
1102
1103
1104class AdminListGroupsForUserResponseModel(BaseModel):
1105    groups: List[GroupTypeModel] = Field(alias="Groups")
1106    next_token: str = Field(alias="NextToken")
1107    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1108
1109
1110class CreateGroupResponseModel(BaseModel):
1111    group: GroupTypeModel = Field(alias="Group")
1112    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1113
1114
1115class GetGroupResponseModel(BaseModel):
1116    group: GroupTypeModel = Field(alias="Group")
1117    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1118
1119
1120class ListGroupsResponseModel(BaseModel):
1121    groups: List[GroupTypeModel] = Field(alias="Groups")
1122    next_token: str = Field(alias="NextToken")
1123    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1124
1125
1126class UpdateGroupResponseModel(BaseModel):
1127    group: GroupTypeModel = Field(alias="Group")
1128    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1129
1130
1131class AdminSetUserMFAPreferenceRequestModel(BaseModel):
1132    username: str = Field(alias="Username")
1133    user_pool_id: str = Field(alias="UserPoolId")
1134    s_ms_mfa_settings: Optional[SMSMfaSettingsTypeModel] = Field(
1135        default=None, alias="SMSMfaSettings"
1136    )
1137    software_token_mfa_settings: Optional[SoftwareTokenMfaSettingsTypeModel] = Field(
1138        default=None, alias="SoftwareTokenMfaSettings"
1139    )
1140
1141
1142class SetUserMFAPreferenceRequestModel(BaseModel):
1143    access_token: str = Field(alias="AccessToken")
1144    s_ms_mfa_settings: Optional[SMSMfaSettingsTypeModel] = Field(
1145        default=None, alias="SMSMfaSettings"
1146    )
1147    software_token_mfa_settings: Optional[SoftwareTokenMfaSettingsTypeModel] = Field(
1148        default=None, alias="SoftwareTokenMfaSettings"
1149    )
1150
1151
1152class AuthEventTypeModel(BaseModel):
1153    event_id: Optional[str] = Field(default=None, alias="EventId")
1154    event_type: Optional[
1155        Literal["ForgotPassword", "PasswordChange", "ResendCode", "SignIn", "SignUp"]
1156    ] = Field(default=None, alias="EventType")
1157    creation_date: Optional[datetime] = Field(default=None, alias="CreationDate")
1158    event_response: Optional[Literal["Fail", "InProgress", "Pass"]] = Field(
1159        default=None, alias="EventResponse"
1160    )
1161    event_risk: Optional[EventRiskTypeModel] = Field(default=None, alias="EventRisk")
1162    challenge_responses: Optional[List[ChallengeResponseTypeModel]] = Field(
1163        default=None, alias="ChallengeResponses"
1164    )
1165    event_context_data: Optional[EventContextDataTypeModel] = Field(
1166        default=None, alias="EventContextData"
1167    )
1168    event_feedback: Optional[EventFeedbackTypeModel] = Field(
1169        default=None, alias="EventFeedback"
1170    )
1171
1172
1173class AuthenticationResultTypeModel(BaseModel):
1174    access_token: Optional[str] = Field(default=None, alias="AccessToken")
1175    expires_in: Optional[int] = Field(default=None, alias="ExpiresIn")
1176    token_type: Optional[str] = Field(default=None, alias="TokenType")
1177    refresh_token: Optional[str] = Field(default=None, alias="RefreshToken")
1178    id_token: Optional[str] = Field(default=None, alias="IdToken")
1179    new_device_metadata: Optional[NewDeviceMetadataTypeModel] = Field(
1180        default=None, alias="NewDeviceMetadata"
1181    )
1182
1183
1184class ForgotPasswordResponseModel(BaseModel):
1185    code_delivery_details: CodeDeliveryDetailsTypeModel = Field(
1186        alias="CodeDeliveryDetails"
1187    )
1188    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1189
1190
1191class GetUserAttributeVerificationCodeResponseModel(BaseModel):
1192    code_delivery_details: CodeDeliveryDetailsTypeModel = Field(
1193        alias="CodeDeliveryDetails"
1194    )
1195    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1196
1197
1198class ResendConfirmationCodeResponseModel(BaseModel):
1199    code_delivery_details: CodeDeliveryDetailsTypeModel = Field(
1200        alias="CodeDeliveryDetails"
1201    )
1202    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1203
1204
1205class SignUpResponseModel(BaseModel):
1206    user_confirmed: bool = Field(alias="UserConfirmed")
1207    code_delivery_details: CodeDeliveryDetailsTypeModel = Field(
1208        alias="CodeDeliveryDetails"
1209    )
1210    user_sub: str = Field(alias="UserSub")
1211    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1212
1213
1214class UpdateUserAttributesResponseModel(BaseModel):
1215    code_delivery_details_list: List[CodeDeliveryDetailsTypeModel] = Field(
1216        alias="CodeDeliveryDetailsList"
1217    )
1218    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1219
1220
1221class CompromisedCredentialsRiskConfigurationTypeModel(BaseModel):
1222    actions: CompromisedCredentialsActionsTypeModel = Field(alias="Actions")
1223    event_filter: Optional[
1224        List[Literal["PASSWORD_CHANGE", "SIGN_IN", "SIGN_UP"]]
1225    ] = Field(default=None, alias="EventFilter")
1226
1227
1228class ConfirmDeviceRequestModel(BaseModel):
1229    access_token: str = Field(alias="AccessToken")
1230    device_key: str = Field(alias="DeviceKey")
1231    device_secret_verifier_config: Optional[
1232        DeviceSecretVerifierConfigTypeModel
1233    ] = Field(default=None, alias="DeviceSecretVerifierConfig")
1234    device_name: Optional[str] = Field(default=None, alias="DeviceName")
1235
1236
1237class ConfirmForgotPasswordRequestModel(BaseModel):
1238    client_id: str = Field(alias="ClientId")
1239    username: str = Field(alias="Username")
1240    confirmation_code: str = Field(alias="ConfirmationCode")
1241    password: str = Field(alias="Password")
1242    secret_hash: Optional[str] = Field(default=None, alias="SecretHash")
1243    analytics_metadata: Optional[AnalyticsMetadataTypeModel] = Field(
1244        default=None, alias="AnalyticsMetadata"
1245    )
1246    user_context_data: Optional[UserContextDataTypeModel] = Field(
1247        default=None, alias="UserContextData"
1248    )
1249    client_metadata: Optional[Mapping[str, str]] = Field(
1250        default=None, alias="ClientMetadata"
1251    )
1252
1253
1254class ConfirmSignUpRequestModel(BaseModel):
1255    client_id: str = Field(alias="ClientId")
1256    username: str = Field(alias="Username")
1257    confirmation_code: str = Field(alias="ConfirmationCode")
1258    secret_hash: Optional[str] = Field(default=None, alias="SecretHash")
1259    force_alias_creation: Optional[bool] = Field(
1260        default=None, alias="ForceAliasCreation"
1261    )
1262    analytics_metadata: Optional[AnalyticsMetadataTypeModel] = Field(
1263        default=None, alias="AnalyticsMetadata"
1264    )
1265    user_context_data: Optional[UserContextDataTypeModel] = Field(
1266        default=None, alias="UserContextData"
1267    )
1268    client_metadata: Optional[Mapping[str, str]] = Field(
1269        default=None, alias="ClientMetadata"
1270    )
1271
1272
1273class ForgotPasswordRequestModel(BaseModel):
1274    client_id: str = Field(alias="ClientId")
1275    username: str = Field(alias="Username")
1276    secret_hash: Optional[str] = Field(default=None, alias="SecretHash")
1277    user_context_data: Optional[UserContextDataTypeModel] = Field(
1278        default=None, alias="UserContextData"
1279    )
1280    analytics_metadata: Optional[AnalyticsMetadataTypeModel] = Field(
1281        default=None, alias="AnalyticsMetadata"
1282    )
1283    client_metadata: Optional[Mapping[str, str]] = Field(
1284        default=None, alias="ClientMetadata"
1285    )
1286
1287
1288class InitiateAuthRequestModel(BaseModel):
1289    auth_flow: Literal[
1290        "ADMIN_NO_SRP_AUTH",
1291        "ADMIN_USER_PASSWORD_AUTH",
1292        "CUSTOM_AUTH",
1293        "REFRESH_TOKEN",
1294        "REFRESH_TOKEN_AUTH",
1295        "USER_PASSWORD_AUTH",
1296        "USER_SRP_AUTH",
1297    ] = Field(alias="AuthFlow")
1298    client_id: str = Field(alias="ClientId")
1299    auth_parameters: Optional[Mapping[str, str]] = Field(
1300        default=None, alias="AuthParameters"
1301    )
1302    client_metadata: Optional[Mapping[str, str]] = Field(
1303        default=None, alias="ClientMetadata"
1304    )
1305    analytics_metadata: Optional[AnalyticsMetadataTypeModel] = Field(
1306        default=None, alias="AnalyticsMetadata"
1307    )
1308    user_context_data: Optional[UserContextDataTypeModel] = Field(
1309        default=None, alias="UserContextData"
1310    )
1311
1312
1313class ResendConfirmationCodeRequestModel(BaseModel):
1314    client_id: str = Field(alias="ClientId")
1315    username: str = Field(alias="Username")
1316    secret_hash: Optional[str] = Field(default=None, alias="SecretHash")
1317    user_context_data: Optional[UserContextDataTypeModel] = Field(
1318        default=None, alias="UserContextData"
1319    )
1320    analytics_metadata: Optional[AnalyticsMetadataTypeModel] = Field(
1321        default=None, alias="AnalyticsMetadata"
1322    )
1323    client_metadata: Optional[Mapping[str, str]] = Field(
1324        default=None, alias="ClientMetadata"
1325    )
1326
1327
1328class RespondToAuthChallengeRequestModel(BaseModel):
1329    client_id: str = Field(alias="ClientId")
1330    challenge_name: Literal[
1331        "ADMIN_NO_SRP_AUTH",
1332        "CUSTOM_CHALLENGE",
1333        "DEVICE_PASSWORD_VERIFIER",
1334        "DEVICE_SRP_AUTH",
1335        "MFA_SETUP",
1336        "NEW_PASSWORD_REQUIRED",
1337        "PASSWORD_VERIFIER",
1338        "SELECT_MFA_TYPE",
1339        "SMS_MFA",
1340        "SOFTWARE_TOKEN_MFA",
1341    ] = Field(alias="ChallengeName")
1342    session: Optional[str] = Field(default=None, alias="Session")
1343    challenge_responses: Optional[Mapping[str, str]] = Field(
1344        default=None, alias="ChallengeResponses"
1345    )
1346    analytics_metadata: Optional[AnalyticsMetadataTypeModel] = Field(
1347        default=None, alias="AnalyticsMetadata"
1348    )
1349    user_context_data: Optional[UserContextDataTypeModel] = Field(
1350        default=None, alias="UserContextData"
1351    )
1352    client_metadata: Optional[Mapping[str, str]] = Field(
1353        default=None, alias="ClientMetadata"
1354    )
1355
1356
1357class SignUpRequestModel(BaseModel):
1358    client_id: str = Field(alias="ClientId")
1359    username: str = Field(alias="Username")
1360    password: str = Field(alias="Password")
1361    secret_hash: Optional[str] = Field(default=None, alias="SecretHash")
1362    user_attributes: Optional[Sequence[AttributeTypeModel]] = Field(
1363        default=None, alias="UserAttributes"
1364    )
1365    validation_data: Optional[Sequence[AttributeTypeModel]] = Field(
1366        default=None, alias="ValidationData"
1367    )
1368    analytics_metadata: Optional[AnalyticsMetadataTypeModel] = Field(
1369        default=None, alias="AnalyticsMetadata"
1370    )
1371    user_context_data: Optional[UserContextDataTypeModel] = Field(
1372        default=None, alias="UserContextData"
1373    )
1374    client_metadata: Optional[Mapping[str, str]] = Field(
1375        default=None, alias="ClientMetadata"
1376    )
1377
1378
1379class ContextDataTypeModel(BaseModel):
1380    ip_address: str = Field(alias="IpAddress")
1381    server_name: str = Field(alias="ServerName")
1382    server_path: str = Field(alias="ServerPath")
1383    http_headers: Sequence[HttpHeaderModel] = Field(alias="HttpHeaders")
1384    encoded_data: Optional[str] = Field(default=None, alias="EncodedData")
1385
1386
1387class CreateIdentityProviderResponseModel(BaseModel):
1388    identity_provider: IdentityProviderTypeModel = Field(alias="IdentityProvider")
1389    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1390
1391
1392class DescribeIdentityProviderResponseModel(BaseModel):
1393    identity_provider: IdentityProviderTypeModel = Field(alias="IdentityProvider")
1394    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1395
1396
1397class GetIdentityProviderByIdentifierResponseModel(BaseModel):
1398    identity_provider: IdentityProviderTypeModel = Field(alias="IdentityProvider")
1399    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1400
1401
1402class UpdateIdentityProviderResponseModel(BaseModel):
1403    identity_provider: IdentityProviderTypeModel = Field(alias="IdentityProvider")
1404    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1405
1406
1407class CreateResourceServerRequestModel(BaseModel):
1408    user_pool_id: str = Field(alias="UserPoolId")
1409    identifier: str = Field(alias="Identifier")
1410    name: str = Field(alias="Name")
1411    scopes: Optional[Sequence[ResourceServerScopeTypeModel]] = Field(
1412        default=None, alias="Scopes"
1413    )
1414
1415
1416class ResourceServerTypeModel(BaseModel):
1417    user_pool_id: Optional[str] = Field(default=None, alias="UserPoolId")
1418    identifier: Optional[str] = Field(default=None, alias="Identifier")
1419    name: Optional[str] = Field(default=None, alias="Name")
1420    scopes: Optional[List[ResourceServerScopeTypeModel]] = Field(
1421        default=None, alias="Scopes"
1422    )
1423
1424
1425class UpdateResourceServerRequestModel(BaseModel):
1426    user_pool_id: str = Field(alias="UserPoolId")
1427    identifier: str = Field(alias="Identifier")
1428    name: str = Field(alias="Name")
1429    scopes: Optional[Sequence[ResourceServerScopeTypeModel]] = Field(
1430        default=None, alias="Scopes"
1431    )
1432
1433
1434class CreateUserImportJobResponseModel(BaseModel):
1435    user_import_job: UserImportJobTypeModel = Field(alias="UserImportJob")
1436    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1437
1438
1439class DescribeUserImportJobResponseModel(BaseModel):
1440    user_import_job: UserImportJobTypeModel = Field(alias="UserImportJob")
1441    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1442
1443
1444class ListUserImportJobsResponseModel(BaseModel):
1445    user_import_jobs: List[UserImportJobTypeModel] = Field(alias="UserImportJobs")
1446    pagination_token: str = Field(alias="PaginationToken")
1447    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1448
1449
1450class StartUserImportJobResponseModel(BaseModel):
1451    user_import_job: UserImportJobTypeModel = Field(alias="UserImportJob")
1452    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1453
1454
1455class StopUserImportJobResponseModel(BaseModel):
1456    user_import_job: UserImportJobTypeModel = Field(alias="UserImportJob")
1457    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1458
1459
1460class CreateUserPoolClientRequestModel(BaseModel):
1461    user_pool_id: str = Field(alias="UserPoolId")
1462    client_name: str = Field(alias="ClientName")
1463    generate_secret: Optional[bool] = Field(default=None, alias="GenerateSecret")
1464    refresh_token_validity: Optional[int] = Field(
1465        default=None, alias="RefreshTokenValidity"
1466    )
1467    access_token_validity: Optional[int] = Field(
1468        default=None, alias="AccessTokenValidity"
1469    )
1470    id_token_validity: Optional[int] = Field(default=None, alias="IdTokenValidity")
1471    token_validity_units: Optional[TokenValidityUnitsTypeModel] = Field(
1472        default=None, alias="TokenValidityUnits"
1473    )
1474    read_attributes: Optional[Sequence[str]] = Field(
1475        default=None, alias="ReadAttributes"
1476    )
1477    write_attributes: Optional[Sequence[str]] = Field(
1478        default=None, alias="WriteAttributes"
1479    )
1480    explicit_auth_flows: Optional[
1481        Sequence[
1482            Literal[
1483                "ADMIN_NO_SRP_AUTH",
1484                "ALLOW_ADMIN_USER_PASSWORD_AUTH",
1485                "ALLOW_CUSTOM_AUTH",
1486                "ALLOW_REFRESH_TOKEN_AUTH",
1487                "ALLOW_USER_PASSWORD_AUTH",
1488                "ALLOW_USER_SRP_AUTH",
1489                "CUSTOM_AUTH_FLOW_ONLY",
1490                "USER_PASSWORD_AUTH",
1491            ]
1492        ]
1493    ] = Field(default=None, alias="ExplicitAuthFlows")
1494    supported_identity_providers: Optional[Sequence[str]] = Field(
1495        default=None, alias="SupportedIdentityProviders"
1496    )
1497    callback_urls: Optional[Sequence[str]] = Field(default=None, alias="CallbackURLs")
1498    logout_urls: Optional[Sequence[str]] = Field(default=None, alias="LogoutURLs")
1499    default_redirect_uri: Optional[str] = Field(
1500        default=None, alias="DefaultRedirectURI"
1501    )
1502    allowed_oauth_flows: Optional[
1503        Sequence[Literal["client_credentials", "code", "implicit"]]
1504    ] = Field(default=None, alias="AllowedOAuthFlows")
1505    allowed_oauth_scopes: Optional[Sequence[str]] = Field(
1506        default=None, alias="AllowedOAuthScopes"
1507    )
1508    allowed_oauth_flows_user_pool_client: Optional[bool] = Field(
1509        default=None, alias="AllowedOAuthFlowsUserPoolClient"
1510    )
1511    analytics_configuration: Optional[AnalyticsConfigurationTypeModel] = Field(
1512        default=None, alias="AnalyticsConfiguration"
1513    )
1514    prevent_user_existence_errors: Optional[Literal["ENABLED", "LEGACY"]] = Field(
1515        default=None, alias="PreventUserExistenceErrors"
1516    )
1517    enable_token_revocation: Optional[bool] = Field(
1518        default=None, alias="EnableTokenRevocation"
1519    )
1520    enable_propagate_additional_user_context_data: Optional[bool] = Field(
1521        default=None, alias="EnablePropagateAdditionalUserContextData"
1522    )
1523    auth_session_validity: Optional[int] = Field(
1524        default=None, alias="AuthSessionValidity"
1525    )
1526
1527
1528class UpdateUserPoolClientRequestModel(BaseModel):
1529    user_pool_id: str = Field(alias="UserPoolId")
1530    client_id: str = Field(alias="ClientId")
1531    client_name: Optional[str] = Field(default=None, alias="ClientName")
1532    refresh_token_validity: Optional[int] = Field(
1533        default=None, alias="RefreshTokenValidity"
1534    )
1535    access_token_validity: Optional[int] = Field(
1536        default=None, alias="AccessTokenValidity"
1537    )
1538    id_token_validity: Optional[int] = Field(default=None, alias="IdTokenValidity")
1539    token_validity_units: Optional[TokenValidityUnitsTypeModel] = Field(
1540        default=None, alias="TokenValidityUnits"
1541    )
1542    read_attributes: Optional[Sequence[str]] = Field(
1543        default=None, alias="ReadAttributes"
1544    )
1545    write_attributes: Optional[Sequence[str]] = Field(
1546        default=None, alias="WriteAttributes"
1547    )
1548    explicit_auth_flows: Optional[
1549        Sequence[
1550            Literal[
1551                "ADMIN_NO_SRP_AUTH",
1552                "ALLOW_ADMIN_USER_PASSWORD_AUTH",
1553                "ALLOW_CUSTOM_AUTH",
1554                "ALLOW_REFRESH_TOKEN_AUTH",
1555                "ALLOW_USER_PASSWORD_AUTH",
1556                "ALLOW_USER_SRP_AUTH",
1557                "CUSTOM_AUTH_FLOW_ONLY",
1558                "USER_PASSWORD_AUTH",
1559            ]
1560        ]
1561    ] = Field(default=None, alias="ExplicitAuthFlows")
1562    supported_identity_providers: Optional[Sequence[str]] = Field(
1563        default=None, alias="SupportedIdentityProviders"
1564    )
1565    callback_urls: Optional[Sequence[str]] = Field(default=None, alias="CallbackURLs")
1566    logout_urls: Optional[Sequence[str]] = Field(default=None, alias="LogoutURLs")
1567    default_redirect_uri: Optional[str] = Field(
1568        default=None, alias="DefaultRedirectURI"
1569    )
1570    allowed_oauth_flows: Optional[
1571        Sequence[Literal["client_credentials", "code", "implicit"]]
1572    ] = Field(default=None, alias="AllowedOAuthFlows")
1573    allowed_oauth_scopes: Optional[Sequence[str]] = Field(
1574        default=None, alias="AllowedOAuthScopes"
1575    )
1576    allowed_oauth_flows_user_pool_client: Optional[bool] = Field(
1577        default=None, alias="AllowedOAuthFlowsUserPoolClient"
1578    )
1579    analytics_configuration: Optional[AnalyticsConfigurationTypeModel] = Field(
1580        default=None, alias="AnalyticsConfiguration"
1581    )
1582    prevent_user_existence_errors: Optional[Literal["ENABLED", "LEGACY"]] = Field(
1583        default=None, alias="PreventUserExistenceErrors"
1584    )
1585    enable_token_revocation: Optional[bool] = Field(
1586        default=None, alias="EnableTokenRevocation"
1587    )
1588    enable_propagate_additional_user_context_data: Optional[bool] = Field(
1589        default=None, alias="EnablePropagateAdditionalUserContextData"
1590    )
1591    auth_session_validity: Optional[int] = Field(
1592        default=None, alias="AuthSessionValidity"
1593    )
1594
1595
1596class UserPoolClientTypeModel(BaseModel):
1597    user_pool_id: Optional[str] = Field(default=None, alias="UserPoolId")
1598    client_name: Optional[str] = Field(default=None, alias="ClientName")
1599    client_id: Optional[str] = Field(default=None, alias="ClientId")
1600    client_secret: Optional[str] = Field(default=None, alias="ClientSecret")
1601    last_modified_date: Optional[datetime] = Field(
1602        default=None, alias="LastModifiedDate"
1603    )
1604    creation_date: Optional[datetime] = Field(default=None, alias="CreationDate")
1605    refresh_token_validity: Optional[int] = Field(
1606        default=None, alias="RefreshTokenValidity"
1607    )
1608    access_token_validity: Optional[int] = Field(
1609        default=None, alias="AccessTokenValidity"
1610    )
1611    id_token_validity: Optional[int] = Field(default=None, alias="IdTokenValidity")
1612    token_validity_units: Optional[TokenValidityUnitsTypeModel] = Field(
1613        default=None, alias="TokenValidityUnits"
1614    )
1615    read_attributes: Optional[List[str]] = Field(default=None, alias="ReadAttributes")
1616    write_attributes: Optional[List[str]] = Field(default=None, alias="WriteAttributes")
1617    explicit_auth_flows: Optional[
1618        List[
1619            Literal[
1620                "ADMIN_NO_SRP_AUTH",
1621                "ALLOW_ADMIN_USER_PASSWORD_AUTH",
1622                "ALLOW_CUSTOM_AUTH",
1623                "ALLOW_REFRESH_TOKEN_AUTH",
1624                "ALLOW_USER_PASSWORD_AUTH",
1625                "ALLOW_USER_SRP_AUTH",
1626                "CUSTOM_AUTH_FLOW_ONLY",
1627                "USER_PASSWORD_AUTH",
1628            ]
1629        ]
1630    ] = Field(default=None, alias="ExplicitAuthFlows")
1631    supported_identity_providers: Optional[List[str]] = Field(
1632        default=None, alias="SupportedIdentityProviders"
1633    )
1634    callback_urls: Optional[List[str]] = Field(default=None, alias="CallbackURLs")
1635    logout_urls: Optional[List[str]] = Field(default=None, alias="LogoutURLs")
1636    default_redirect_uri: Optional[str] = Field(
1637        default=None, alias="DefaultRedirectURI"
1638    )
1639    allowed_oauth_flows: Optional[
1640        List[Literal["client_credentials", "code", "implicit"]]
1641    ] = Field(default=None, alias="AllowedOAuthFlows")
1642    allowed_oauth_scopes: Optional[List[str]] = Field(
1643        default=None, alias="AllowedOAuthScopes"
1644    )
1645    allowed_oauth_flows_user_pool_client: Optional[bool] = Field(
1646        default=None, alias="AllowedOAuthFlowsUserPoolClient"
1647    )
1648    analytics_configuration: Optional[AnalyticsConfigurationTypeModel] = Field(
1649        default=None, alias="AnalyticsConfiguration"
1650    )
1651    prevent_user_existence_errors: Optional[Literal["ENABLED", "LEGACY"]] = Field(
1652        default=None, alias="PreventUserExistenceErrors"
1653    )
1654    enable_token_revocation: Optional[bool] = Field(
1655        default=None, alias="EnableTokenRevocation"
1656    )
1657    enable_propagate_additional_user_context_data: Optional[bool] = Field(
1658        default=None, alias="EnablePropagateAdditionalUserContextData"
1659    )
1660    auth_session_validity: Optional[int] = Field(
1661        default=None, alias="AuthSessionValidity"
1662    )
1663
1664
1665class CreateUserPoolDomainRequestModel(BaseModel):
1666    domain: str = Field(alias="Domain")
1667    user_pool_id: str = Field(alias="UserPoolId")
1668    custom_domain_config: Optional[CustomDomainConfigTypeModel] = Field(
1669        default=None, alias="CustomDomainConfig"
1670    )
1671
1672
1673class DomainDescriptionTypeModel(BaseModel):
1674    user_pool_id: Optional[str] = Field(default=None, alias="UserPoolId")
1675    aws_account_id: Optional[str] = Field(default=None, alias="AWSAccountId")
1676    domain: Optional[str] = Field(default=None, alias="Domain")
1677    s3_bucket: Optional[str] = Field(default=None, alias="S3Bucket")
1678    cloud_front_distribution: Optional[str] = Field(
1679        default=None, alias="CloudFrontDistribution"
1680    )
1681    version: Optional[str] = Field(default=None, alias="Version")
1682    status: Optional[
1683        Literal["ACTIVE", "CREATING", "DELETING", "FAILED", "UPDATING"]
1684    ] = Field(default=None, alias="Status")
1685    custom_domain_config: Optional[CustomDomainConfigTypeModel] = Field(
1686        default=None, alias="CustomDomainConfig"
1687    )
1688
1689
1690class UpdateUserPoolDomainRequestModel(BaseModel):
1691    domain: str = Field(alias="Domain")
1692    user_pool_id: str = Field(alias="UserPoolId")
1693    custom_domain_config: CustomDomainConfigTypeModel = Field(
1694        alias="CustomDomainConfig"
1695    )
1696
1697
1698class SmsMfaConfigTypeModel(BaseModel):
1699    sms_authentication_message: Optional[str] = Field(
1700        default=None, alias="SmsAuthenticationMessage"
1701    )
1702    sms_configuration: Optional[SmsConfigurationTypeModel] = Field(
1703        default=None, alias="SmsConfiguration"
1704    )
1705
1706
1707class LambdaConfigTypeModel(BaseModel):
1708    pre_sign_up: Optional[str] = Field(default=None, alias="PreSignUp")
1709    custom_message: Optional[str] = Field(default=None, alias="CustomMessage")
1710    post_confirmation: Optional[str] = Field(default=None, alias="PostConfirmation")
1711    pre_authentication: Optional[str] = Field(default=None, alias="PreAuthentication")
1712    post_authentication: Optional[str] = Field(default=None, alias="PostAuthentication")
1713    define_auth_challenge: Optional[str] = Field(
1714        default=None, alias="DefineAuthChallenge"
1715    )
1716    create_auth_challenge: Optional[str] = Field(
1717        default=None, alias="CreateAuthChallenge"
1718    )
1719    verify_auth_challenge_response: Optional[str] = Field(
1720        default=None, alias="VerifyAuthChallengeResponse"
1721    )
1722    pre_token_generation: Optional[str] = Field(
1723        default=None, alias="PreTokenGeneration"
1724    )
1725    user_migration: Optional[str] = Field(default=None, alias="UserMigration")
1726    custom_s_ms_sender: Optional[CustomSMSLambdaVersionConfigTypeModel] = Field(
1727        default=None, alias="CustomSMSSender"
1728    )
1729    custom_email_sender: Optional[CustomEmailLambdaVersionConfigTypeModel] = Field(
1730        default=None, alias="CustomEmailSender"
1731    )
1732    kms_key_id: Optional[str] = Field(default=None, alias="KMSKeyID")
1733
1734
1735class GetUICustomizationResponseModel(BaseModel):
1736    uicustomization: UICustomizationTypeModel = Field(alias="UICustomization")
1737    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1738
1739
1740class SetUICustomizationResponseModel(BaseModel):
1741    uicustomization: UICustomizationTypeModel = Field(alias="UICustomization")
1742    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1743
1744
1745class ListIdentityProvidersResponseModel(BaseModel):
1746    providers: List[ProviderDescriptionModel] = Field(alias="Providers")
1747    next_token: str = Field(alias="NextToken")
1748    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1749
1750
1751class ListUserPoolClientsResponseModel(BaseModel):
1752    user_pool_clients: List[UserPoolClientDescriptionModel] = Field(
1753        alias="UserPoolClients"
1754    )
1755    next_token: str = Field(alias="NextToken")
1756    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1757
1758
1759class NotifyConfigurationTypeModel(BaseModel):
1760    source_arn: str = Field(alias="SourceArn")
1761    from_: Optional[str] = Field(default=None, alias="From")
1762    reply_to: Optional[str] = Field(default=None, alias="ReplyTo")
1763    block_email: Optional[NotifyEmailTypeModel] = Field(
1764        default=None, alias="BlockEmail"
1765    )
1766    no_action_email: Optional[NotifyEmailTypeModel] = Field(
1767        default=None, alias="NoActionEmail"
1768    )
1769    mfa_email: Optional[NotifyEmailTypeModel] = Field(default=None, alias="MfaEmail")
1770
1771
1772class UserPoolPolicyTypeModel(BaseModel):
1773    password_policy: Optional[PasswordPolicyTypeModel] = Field(
1774        default=None, alias="PasswordPolicy"
1775    )
1776
1777
1778class SchemaAttributeTypeModel(BaseModel):
1779    name: Optional[str] = Field(default=None, alias="Name")
1780    attribute_data_type: Optional[
1781        Literal["Boolean", "DateTime", "Number", "String"]
1782    ] = Field(default=None, alias="AttributeDataType")
1783    developer_only_attribute: Optional[bool] = Field(
1784        default=None, alias="DeveloperOnlyAttribute"
1785    )
1786    mutable: Optional[bool] = Field(default=None, alias="Mutable")
1787    required: Optional[bool] = Field(default=None, alias="Required")
1788    number_attribute_constraints: Optional[NumberAttributeConstraintsTypeModel] = Field(
1789        default=None, alias="NumberAttributeConstraints"
1790    )
1791    string_attribute_constraints: Optional[StringAttributeConstraintsTypeModel] = Field(
1792        default=None, alias="StringAttributeConstraints"
1793    )
1794
1795
1796class AdminGetDeviceResponseModel(BaseModel):
1797    device: DeviceTypeModel = Field(alias="Device")
1798    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1799
1800
1801class AdminListDevicesResponseModel(BaseModel):
1802    devices: List[DeviceTypeModel] = Field(alias="Devices")
1803    pagination_token: str = Field(alias="PaginationToken")
1804    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1805
1806
1807class GetDeviceResponseModel(BaseModel):
1808    device: DeviceTypeModel = Field(alias="Device")
1809    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1810
1811
1812class ListDevicesResponseModel(BaseModel):
1813    devices: List[DeviceTypeModel] = Field(alias="Devices")
1814    pagination_token: str = Field(alias="PaginationToken")
1815    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1816
1817
1818class AdminCreateUserResponseModel(BaseModel):
1819    user: UserTypeModel = Field(alias="User")
1820    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1821
1822
1823class ListUsersInGroupResponseModel(BaseModel):
1824    users: List[UserTypeModel] = Field(alias="Users")
1825    next_token: str = Field(alias="NextToken")
1826    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1827
1828
1829class ListUsersResponseModel(BaseModel):
1830    users: List[UserTypeModel] = Field(alias="Users")
1831    pagination_token: str = Field(alias="PaginationToken")
1832    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1833
1834
1835class AdminListUserAuthEventsResponseModel(BaseModel):
1836    auth_events: List[AuthEventTypeModel] = Field(alias="AuthEvents")
1837    next_token: str = Field(alias="NextToken")
1838    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1839
1840
1841class AdminInitiateAuthResponseModel(BaseModel):
1842    challenge_name: Literal[
1843        "ADMIN_NO_SRP_AUTH",
1844        "CUSTOM_CHALLENGE",
1845        "DEVICE_PASSWORD_VERIFIER",
1846        "DEVICE_SRP_AUTH",
1847        "MFA_SETUP",
1848        "NEW_PASSWORD_REQUIRED",
1849        "PASSWORD_VERIFIER",
1850        "SELECT_MFA_TYPE",
1851        "SMS_MFA",
1852        "SOFTWARE_TOKEN_MFA",
1853    ] = Field(alias="ChallengeName")
1854    session: str = Field(alias="Session")
1855    challenge_parameters: Dict[str, str] = Field(alias="ChallengeParameters")
1856    authentication_result: AuthenticationResultTypeModel = Field(
1857        alias="AuthenticationResult"
1858    )
1859    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1860
1861
1862class AdminRespondToAuthChallengeResponseModel(BaseModel):
1863    challenge_name: Literal[
1864        "ADMIN_NO_SRP_AUTH",
1865        "CUSTOM_CHALLENGE",
1866        "DEVICE_PASSWORD_VERIFIER",
1867        "DEVICE_SRP_AUTH",
1868        "MFA_SETUP",
1869        "NEW_PASSWORD_REQUIRED",
1870        "PASSWORD_VERIFIER",
1871        "SELECT_MFA_TYPE",
1872        "SMS_MFA",
1873        "SOFTWARE_TOKEN_MFA",
1874    ] = Field(alias="ChallengeName")
1875    session: str = Field(alias="Session")
1876    challenge_parameters: Dict[str, str] = Field(alias="ChallengeParameters")
1877    authentication_result: AuthenticationResultTypeModel = Field(
1878        alias="AuthenticationResult"
1879    )
1880    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1881
1882
1883class InitiateAuthResponseModel(BaseModel):
1884    challenge_name: Literal[
1885        "ADMIN_NO_SRP_AUTH",
1886        "CUSTOM_CHALLENGE",
1887        "DEVICE_PASSWORD_VERIFIER",
1888        "DEVICE_SRP_AUTH",
1889        "MFA_SETUP",
1890        "NEW_PASSWORD_REQUIRED",
1891        "PASSWORD_VERIFIER",
1892        "SELECT_MFA_TYPE",
1893        "SMS_MFA",
1894        "SOFTWARE_TOKEN_MFA",
1895    ] = Field(alias="ChallengeName")
1896    session: str = Field(alias="Session")
1897    challenge_parameters: Dict[str, str] = Field(alias="ChallengeParameters")
1898    authentication_result: AuthenticationResultTypeModel = Field(
1899        alias="AuthenticationResult"
1900    )
1901    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1902
1903
1904class RespondToAuthChallengeResponseModel(BaseModel):
1905    challenge_name: Literal[
1906        "ADMIN_NO_SRP_AUTH",
1907        "CUSTOM_CHALLENGE",
1908        "DEVICE_PASSWORD_VERIFIER",
1909        "DEVICE_SRP_AUTH",
1910        "MFA_SETUP",
1911        "NEW_PASSWORD_REQUIRED",
1912        "PASSWORD_VERIFIER",
1913        "SELECT_MFA_TYPE",
1914        "SMS_MFA",
1915        "SOFTWARE_TOKEN_MFA",
1916    ] = Field(alias="ChallengeName")
1917    session: str = Field(alias="Session")
1918    challenge_parameters: Dict[str, str] = Field(alias="ChallengeParameters")
1919    authentication_result: AuthenticationResultTypeModel = Field(
1920        alias="AuthenticationResult"
1921    )
1922    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1923
1924
1925class AdminInitiateAuthRequestModel(BaseModel):
1926    user_pool_id: str = Field(alias="UserPoolId")
1927    client_id: str = Field(alias="ClientId")
1928    auth_flow: Literal[
1929        "ADMIN_NO_SRP_AUTH",
1930        "ADMIN_USER_PASSWORD_AUTH",
1931        "CUSTOM_AUTH",
1932        "REFRESH_TOKEN",
1933        "REFRESH_TOKEN_AUTH",
1934        "USER_PASSWORD_AUTH",
1935        "USER_SRP_AUTH",
1936    ] = Field(alias="AuthFlow")
1937    auth_parameters: Optional[Mapping[str, str]] = Field(
1938        default=None, alias="AuthParameters"
1939    )
1940    client_metadata: Optional[Mapping[str, str]] = Field(
1941        default=None, alias="ClientMetadata"
1942    )
1943    analytics_metadata: Optional[AnalyticsMetadataTypeModel] = Field(
1944        default=None, alias="AnalyticsMetadata"
1945    )
1946    context_data: Optional[ContextDataTypeModel] = Field(
1947        default=None, alias="ContextData"
1948    )
1949
1950
1951class AdminRespondToAuthChallengeRequestModel(BaseModel):
1952    user_pool_id: str = Field(alias="UserPoolId")
1953    client_id: str = Field(alias="ClientId")
1954    challenge_name: Literal[
1955        "ADMIN_NO_SRP_AUTH",
1956        "CUSTOM_CHALLENGE",
1957        "DEVICE_PASSWORD_VERIFIER",
1958        "DEVICE_SRP_AUTH",
1959        "MFA_SETUP",
1960        "NEW_PASSWORD_REQUIRED",
1961        "PASSWORD_VERIFIER",
1962        "SELECT_MFA_TYPE",
1963        "SMS_MFA",
1964        "SOFTWARE_TOKEN_MFA",
1965    ] = Field(alias="ChallengeName")
1966    challenge_responses: Optional[Mapping[str, str]] = Field(
1967        default=None, alias="ChallengeResponses"
1968    )
1969    session: Optional[str] = Field(default=None, alias="Session")
1970    analytics_metadata: Optional[AnalyticsMetadataTypeModel] = Field(
1971        default=None, alias="AnalyticsMetadata"
1972    )
1973    context_data: Optional[ContextDataTypeModel] = Field(
1974        default=None, alias="ContextData"
1975    )
1976    client_metadata: Optional[Mapping[str, str]] = Field(
1977        default=None, alias="ClientMetadata"
1978    )
1979
1980
1981class CreateResourceServerResponseModel(BaseModel):
1982    resource_server: ResourceServerTypeModel = Field(alias="ResourceServer")
1983    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1984
1985
1986class DescribeResourceServerResponseModel(BaseModel):
1987    resource_server: ResourceServerTypeModel = Field(alias="ResourceServer")
1988    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1989
1990
1991class ListResourceServersResponseModel(BaseModel):
1992    resource_servers: List[ResourceServerTypeModel] = Field(alias="ResourceServers")
1993    next_token: str = Field(alias="NextToken")
1994    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1995
1996
1997class UpdateResourceServerResponseModel(BaseModel):
1998    resource_server: ResourceServerTypeModel = Field(alias="ResourceServer")
1999    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
2000
2001
2002class CreateUserPoolClientResponseModel(BaseModel):
2003    user_pool_client: UserPoolClientTypeModel = Field(alias="UserPoolClient")
2004    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
2005
2006
2007class DescribeUserPoolClientResponseModel(BaseModel):
2008    user_pool_client: UserPoolClientTypeModel = Field(alias="UserPoolClient")
2009    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
2010
2011
2012class UpdateUserPoolClientResponseModel(BaseModel):
2013    user_pool_client: UserPoolClientTypeModel = Field(alias="UserPoolClient")
2014    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
2015
2016
2017class DescribeUserPoolDomainResponseModel(BaseModel):
2018    domain_description: DomainDescriptionTypeModel = Field(alias="DomainDescription")
2019    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
2020
2021
2022class GetUserPoolMfaConfigResponseModel(BaseModel):
2023    sms_mfa_configuration: SmsMfaConfigTypeModel = Field(alias="SmsMfaConfiguration")
2024    software_token_mfa_configuration: SoftwareTokenMfaConfigTypeModel = Field(
2025        alias="SoftwareTokenMfaConfiguration"
2026    )
2027    mfa_configuration: Literal["OFF", "ON", "OPTIONAL"] = Field(
2028        alias="MfaConfiguration"
2029    )
2030    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
2031
2032
2033class SetUserPoolMfaConfigRequestModel(BaseModel):
2034    user_pool_id: str = Field(alias="UserPoolId")
2035    sms_mfa_configuration: Optional[SmsMfaConfigTypeModel] = Field(
2036        default=None, alias="SmsMfaConfiguration"
2037    )
2038    software_token_mfa_configuration: Optional[SoftwareTokenMfaConfigTypeModel] = Field(
2039        default=None, alias="SoftwareTokenMfaConfiguration"
2040    )
2041    mfa_configuration: Optional[Literal["OFF", "ON", "OPTIONAL"]] = Field(
2042        default=None, alias="MfaConfiguration"
2043    )
2044
2045
2046class SetUserPoolMfaConfigResponseModel(BaseModel):
2047    sms_mfa_configuration: SmsMfaConfigTypeModel = Field(alias="SmsMfaConfiguration")
2048    software_token_mfa_configuration: SoftwareTokenMfaConfigTypeModel = Field(
2049        alias="SoftwareTokenMfaConfiguration"
2050    )
2051    mfa_configuration: Literal["OFF", "ON", "OPTIONAL"] = Field(
2052        alias="MfaConfiguration"
2053    )
2054    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
2055
2056
2057class UserPoolDescriptionTypeModel(BaseModel):
2058    id: Optional[str] = Field(default=None, alias="Id")
2059    name: Optional[str] = Field(default=None, alias="Name")
2060    lambda_config: Optional[LambdaConfigTypeModel] = Field(
2061        default=None, alias="LambdaConfig"
2062    )
2063    status: Optional[Literal["Disabled", "Enabled"]] = Field(
2064        default=None, alias="Status"
2065    )
2066    last_modified_date: Optional[datetime] = Field(
2067        default=None, alias="LastModifiedDate"
2068    )
2069    creation_date: Optional[datetime] = Field(default=None, alias="CreationDate")
2070
2071
2072class AccountTakeoverRiskConfigurationTypeModel(BaseModel):
2073    actions: AccountTakeoverActionsTypeModel = Field(alias="Actions")
2074    notify_configuration: Optional[NotifyConfigurationTypeModel] = Field(
2075        default=None, alias="NotifyConfiguration"
2076    )
2077
2078
2079class UpdateUserPoolRequestModel(BaseModel):
2080    user_pool_id: str = Field(alias="UserPoolId")
2081    policies: Optional[UserPoolPolicyTypeModel] = Field(default=None, alias="Policies")
2082    deletion_protection: Optional[Literal["ACTIVE", "INACTIVE"]] = Field(
2083        default=None, alias="DeletionProtection"
2084    )
2085    lambda_config: Optional[LambdaConfigTypeModel] = Field(
2086        default=None, alias="LambdaConfig"
2087    )
2088    auto_verified_attributes: Optional[
2089        Sequence[Literal["email", "phone_number"]]
2090    ] = Field(default=None, alias="AutoVerifiedAttributes")
2091    sms_verification_message: Optional[str] = Field(
2092        default=None, alias="SmsVerificationMessage"
2093    )
2094    email_verification_message: Optional[str] = Field(
2095        default=None, alias="EmailVerificationMessage"
2096    )
2097    email_verification_subject: Optional[str] = Field(
2098        default=None, alias="EmailVerificationSubject"
2099    )
2100    verification_message_template: Optional[
2101        VerificationMessageTemplateTypeModel
2102    ] = Field(default=None, alias="VerificationMessageTemplate")
2103    sms_authentication_message: Optional[str] = Field(
2104        default=None, alias="SmsAuthenticationMessage"
2105    )
2106    user_attribute_update_settings: Optional[
2107        UserAttributeUpdateSettingsTypeModel
2108    ] = Field(default=None, alias="UserAttributeUpdateSettings")
2109    mfa_configuration: Optional[Literal["OFF", "ON", "OPTIONAL"]] = Field(
2110        default=None, alias="MfaConfiguration"
2111    )
2112    device_configuration: Optional[DeviceConfigurationTypeModel] = Field(
2113        default=None, alias="DeviceConfiguration"
2114    )
2115    email_configuration: Optional[EmailConfigurationTypeModel] = Field(
2116        default=None, alias="EmailConfiguration"
2117    )
2118    sms_configuration: Optional[SmsConfigurationTypeModel] = Field(
2119        default=None, alias="SmsConfiguration"
2120    )
2121    user_pool_tags: Optional[Mapping[str, str]] = Field(
2122        default=None, alias="UserPoolTags"
2123    )
2124    admin_create_user_config: Optional[AdminCreateUserConfigTypeModel] = Field(
2125        default=None, alias="AdminCreateUserConfig"
2126    )
2127    user_pool_add_ons: Optional[UserPoolAddOnsTypeModel] = Field(
2128        default=None, alias="UserPoolAddOns"
2129    )
2130    account_recovery_setting: Optional[AccountRecoverySettingTypeModel] = Field(
2131        default=None, alias="AccountRecoverySetting"
2132    )
2133
2134
2135class AddCustomAttributesRequestModel(BaseModel):
2136    user_pool_id: str = Field(alias="UserPoolId")
2137    custom_attributes: Sequence[SchemaAttributeTypeModel] = Field(
2138        alias="CustomAttributes"
2139    )
2140
2141
2142class CreateUserPoolRequestModel(BaseModel):
2143    pool_name: str = Field(alias="PoolName")
2144    policies: Optional[UserPoolPolicyTypeModel] = Field(default=None, alias="Policies")
2145    deletion_protection: Optional[Literal["ACTIVE", "INACTIVE"]] = Field(
2146        default=None, alias="DeletionProtection"
2147    )
2148    lambda_config: Optional[LambdaConfigTypeModel] = Field(
2149        default=None, alias="LambdaConfig"
2150    )
2151    auto_verified_attributes: Optional[
2152        Sequence[Literal["email", "phone_number"]]
2153    ] = Field(default=None, alias="AutoVerifiedAttributes")
2154    alias_attributes: Optional[
2155        Sequence[Literal["email", "phone_number", "preferred_username"]]
2156    ] = Field(default=None, alias="AliasAttributes")
2157    username_attributes: Optional[Sequence[Literal["email", "phone_number"]]] = Field(
2158        default=None, alias="UsernameAttributes"
2159    )
2160    sms_verification_message: Optional[str] = Field(
2161        default=None, alias="SmsVerificationMessage"
2162    )
2163    email_verification_message: Optional[str] = Field(
2164        default=None, alias="EmailVerificationMessage"
2165    )
2166    email_verification_subject: Optional[str] = Field(
2167        default=None, alias="EmailVerificationSubject"
2168    )
2169    verification_message_template: Optional[
2170        VerificationMessageTemplateTypeModel
2171    ] = Field(default=None, alias="VerificationMessageTemplate")
2172    sms_authentication_message: Optional[str] = Field(
2173        default=None, alias="SmsAuthenticationMessage"
2174    )
2175    mfa_configuration: Optional[Literal["OFF", "ON", "OPTIONAL"]] = Field(
2176        default=None, alias="MfaConfiguration"
2177    )
2178    user_attribute_update_settings: Optional[
2179        UserAttributeUpdateSettingsTypeModel
2180    ] = Field(default=None, alias="UserAttributeUpdateSettings")
2181    device_configuration: Optional[DeviceConfigurationTypeModel] = Field(
2182        default=None, alias="DeviceConfiguration"
2183    )
2184    email_configuration: Optional[EmailConfigurationTypeModel] = Field(
2185        default=None, alias="EmailConfiguration"
2186    )
2187    sms_configuration: Optional[SmsConfigurationTypeModel] = Field(
2188        default=None, alias="SmsConfiguration"
2189    )
2190    user_pool_tags: Optional[Mapping[str, str]] = Field(
2191        default=None, alias="UserPoolTags"
2192    )
2193    admin_create_user_config: Optional[AdminCreateUserConfigTypeModel] = Field(
2194        default=None, alias="AdminCreateUserConfig"
2195    )
2196    schema_: Optional[Sequence[SchemaAttributeTypeModel]] = Field(
2197        default=None, alias="Schema"
2198    )
2199    user_pool_add_ons: Optional[UserPoolAddOnsTypeModel] = Field(
2200        default=None, alias="UserPoolAddOns"
2201    )
2202    username_configuration: Optional[UsernameConfigurationTypeModel] = Field(
2203        default=None, alias="UsernameConfiguration"
2204    )
2205    account_recovery_setting: Optional[AccountRecoverySettingTypeModel] = Field(
2206        default=None, alias="AccountRecoverySetting"
2207    )
2208
2209
2210class UserPoolTypeModel(BaseModel):
2211    id: Optional[str] = Field(default=None, alias="Id")
2212    name: Optional[str] = Field(default=None, alias="Name")
2213    policies: Optional[UserPoolPolicyTypeModel] = Field(default=None, alias="Policies")
2214    deletion_protection: Optional[Literal["ACTIVE", "INACTIVE"]] = Field(
2215        default=None, alias="DeletionProtection"
2216    )
2217    lambda_config: Optional[LambdaConfigTypeModel] = Field(
2218        default=None, alias="LambdaConfig"
2219    )
2220    status: Optional[Literal["Disabled", "Enabled"]] = Field(
2221        default=None, alias="Status"
2222    )
2223    last_modified_date: Optional[datetime] = Field(
2224        default=None, alias="LastModifiedDate"
2225    )
2226    creation_date: Optional[datetime] = Field(default=None, alias="CreationDate")
2227    schema_attributes: Optional[List[SchemaAttributeTypeModel]] = Field(
2228        default=None, alias="SchemaAttributes"
2229    )
2230    auto_verified_attributes: Optional[List[Literal["email", "phone_number"]]] = Field(
2231        default=None, alias="AutoVerifiedAttributes"
2232    )
2233    alias_attributes: Optional[
2234        List[Literal["email", "phone_number", "preferred_username"]]
2235    ] = Field(default=None, alias="AliasAttributes")
2236    username_attributes: Optional[List[Literal["email", "phone_number"]]] = Field(
2237        default=None, alias="UsernameAttributes"
2238    )
2239    sms_verification_message: Optional[str] = Field(
2240        default=None, alias="SmsVerificationMessage"
2241    )
2242    email_verification_message: Optional[str] = Field(
2243        default=None, alias="EmailVerificationMessage"
2244    )
2245    email_verification_subject: Optional[str] = Field(
2246        default=None, alias="EmailVerificationSubject"
2247    )
2248    verification_message_template: Optional[
2249        VerificationMessageTemplateTypeModel
2250    ] = Field(default=None, alias="VerificationMessageTemplate")
2251    sms_authentication_message: Optional[str] = Field(
2252        default=None, alias="SmsAuthenticationMessage"
2253    )
2254    user_attribute_update_settings: Optional[
2255        UserAttributeUpdateSettingsTypeModel
2256    ] = Field(default=None, alias="UserAttributeUpdateSettings")
2257    mfa_configuration: Optional[Literal["OFF", "ON", "OPTIONAL"]] = Field(
2258        default=None, alias="MfaConfiguration"
2259    )
2260    device_configuration: Optional[DeviceConfigurationTypeModel] = Field(
2261        default=None, alias="DeviceConfiguration"
2262    )
2263    estimated_number_of_users: Optional[int] = Field(
2264        default=None, alias="EstimatedNumberOfUsers"
2265    )
2266    email_configuration: Optional[EmailConfigurationTypeModel] = Field(
2267        default=None, alias="EmailConfiguration"
2268    )
2269    sms_configuration: Optional[SmsConfigurationTypeModel] = Field(
2270        default=None, alias="SmsConfiguration"
2271    )
2272    user_pool_tags: Optional[Dict[str, str]] = Field(default=None, alias="UserPoolTags")
2273    sms_configuration_failure: Optional[str] = Field(
2274        default=None, alias="SmsConfigurationFailure"
2275    )
2276    email_configuration_failure: Optional[str] = Field(
2277        default=None, alias="EmailConfigurationFailure"
2278    )
2279    domain: Optional[str] = Field(default=None, alias="Domain")
2280    custom_domain: Optional[str] = Field(default=None, alias="CustomDomain")
2281    admin_create_user_config: Optional[AdminCreateUserConfigTypeModel] = Field(
2282        default=None, alias="AdminCreateUserConfig"
2283    )
2284    user_pool_add_ons: Optional[UserPoolAddOnsTypeModel] = Field(
2285        default=None, alias="UserPoolAddOns"
2286    )
2287    username_configuration: Optional[UsernameConfigurationTypeModel] = Field(
2288        default=None, alias="UsernameConfiguration"
2289    )
2290    arn: Optional[str] = Field(default=None, alias="Arn")
2291    account_recovery_setting: Optional[AccountRecoverySettingTypeModel] = Field(
2292        default=None, alias="AccountRecoverySetting"
2293    )
2294
2295
2296class ListUserPoolsResponseModel(BaseModel):
2297    user_pools: List[UserPoolDescriptionTypeModel] = Field(alias="UserPools")
2298    next_token: str = Field(alias="NextToken")
2299    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
2300
2301
2302class RiskConfigurationTypeModel(BaseModel):
2303    user_pool_id: Optional[str] = Field(default=None, alias="UserPoolId")
2304    client_id: Optional[str] = Field(default=None, alias="ClientId")
2305    compromised_credentials_risk_configuration: Optional[
2306        CompromisedCredentialsRiskConfigurationTypeModel
2307    ] = Field(default=None, alias="CompromisedCredentialsRiskConfiguration")
2308    account_takeover_risk_configuration: Optional[
2309        AccountTakeoverRiskConfigurationTypeModel
2310    ] = Field(default=None, alias="AccountTakeoverRiskConfiguration")
2311    risk_exception_configuration: Optional[RiskExceptionConfigurationTypeModel] = Field(
2312        default=None, alias="RiskExceptionConfiguration"
2313    )
2314    last_modified_date: Optional[datetime] = Field(
2315        default=None, alias="LastModifiedDate"
2316    )
2317
2318
2319class SetRiskConfigurationRequestModel(BaseModel):
2320    user_pool_id: str = Field(alias="UserPoolId")
2321    client_id: Optional[str] = Field(default=None, alias="ClientId")
2322    compromised_credentials_risk_configuration: Optional[
2323        CompromisedCredentialsRiskConfigurationTypeModel
2324    ] = Field(default=None, alias="CompromisedCredentialsRiskConfiguration")
2325    account_takeover_risk_configuration: Optional[
2326        AccountTakeoverRiskConfigurationTypeModel
2327    ] = Field(default=None, alias="AccountTakeoverRiskConfiguration")
2328    risk_exception_configuration: Optional[RiskExceptionConfigurationTypeModel] = Field(
2329        default=None, alias="RiskExceptionConfiguration"
2330    )
2331
2332
2333class CreateUserPoolResponseModel(BaseModel):
2334    user_pool: UserPoolTypeModel = Field(alias="UserPool")
2335    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
2336
2337
2338class DescribeUserPoolResponseModel(BaseModel):
2339    user_pool: UserPoolTypeModel = Field(alias="UserPool")
2340    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
2341
2342
2343class DescribeRiskConfigurationResponseModel(BaseModel):
2344    risk_configuration: RiskConfigurationTypeModel = Field(alias="RiskConfiguration")
2345    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
2346
2347
2348class SetRiskConfigurationResponseModel(BaseModel):
2349    risk_configuration: RiskConfigurationTypeModel = Field(alias="RiskConfiguration")
2350    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")